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 4
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_G1][UFS_LANE_2] = { 1844, 1000 },
71 [MODE_PWM][UFS_PWM_G2][UFS_LANE_2] = { 3688, 1000 },
72 [MODE_PWM][UFS_PWM_G3][UFS_LANE_2] = { 7376, 1000 },
73 [MODE_PWM][UFS_PWM_G4][UFS_LANE_2] = { 14752, 1000 },
74 [MODE_HS_RA][UFS_HS_G1][UFS_LANE_1] = { 127796, 1000 },
75 [MODE_HS_RA][UFS_HS_G2][UFS_LANE_1] = { 255591, 1000 },
76 [MODE_HS_RA][UFS_HS_G3][UFS_LANE_1] = { 1492582, 102400 },
77 [MODE_HS_RA][UFS_HS_G4][UFS_LANE_1] = { 2915200, 204800 },
78 [MODE_HS_RA][UFS_HS_G1][UFS_LANE_2] = { 255591, 1000 },
79 [MODE_HS_RA][UFS_HS_G2][UFS_LANE_2] = { 511181, 1000 },
80 [MODE_HS_RA][UFS_HS_G3][UFS_LANE_2] = { 1492582, 204800 },
81 [MODE_HS_RA][UFS_HS_G4][UFS_LANE_2] = { 2915200, 409600 },
82 [MODE_HS_RB][UFS_HS_G1][UFS_LANE_1] = { 149422, 1000 },
83 [MODE_HS_RB][UFS_HS_G2][UFS_LANE_1] = { 298189, 1000 },
84 [MODE_HS_RB][UFS_HS_G3][UFS_LANE_1] = { 1492582, 102400 },
85 [MODE_HS_RB][UFS_HS_G4][UFS_LANE_1] = { 2915200, 204800 },
86 [MODE_HS_RB][UFS_HS_G1][UFS_LANE_2] = { 298189, 1000 },
87 [MODE_HS_RB][UFS_HS_G2][UFS_LANE_2] = { 596378, 1000 },
88 [MODE_HS_RB][UFS_HS_G3][UFS_LANE_2] = { 1492582, 204800 },
89 [MODE_HS_RB][UFS_HS_G4][UFS_LANE_2] = { 2915200, 409600 },
90 [MODE_MAX][0][0] = { 7643136, 307200 },
93 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host);
94 static int ufs_qcom_set_core_clk_ctrl(struct ufs_hba *hba, bool is_scale_up);
96 static struct ufs_qcom_host *rcdev_to_ufs_host(struct reset_controller_dev *rcd)
98 return container_of(rcd, struct ufs_qcom_host, rcdev);
101 #ifdef CONFIG_SCSI_UFS_CRYPTO
103 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host *host)
105 if (host->hba->caps & UFSHCD_CAP_CRYPTO)
106 qcom_ice_enable(host->ice);
109 static int ufs_qcom_ice_init(struct ufs_qcom_host *host)
111 struct ufs_hba *hba = host->hba;
112 struct device *dev = hba->dev;
113 struct qcom_ice *ice;
115 ice = of_qcom_ice_get(dev);
116 if (ice == ERR_PTR(-EOPNOTSUPP)) {
117 dev_warn(dev, "Disabling inline encryption support\n");
121 if (IS_ERR_OR_NULL(ice))
122 return PTR_ERR_OR_ZERO(ice);
125 hba->caps |= UFSHCD_CAP_CRYPTO;
130 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host *host)
132 if (host->hba->caps & UFSHCD_CAP_CRYPTO)
133 return qcom_ice_resume(host->ice);
138 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host *host)
140 if (host->hba->caps & UFSHCD_CAP_CRYPTO)
141 return qcom_ice_suspend(host->ice);
146 static int ufs_qcom_ice_program_key(struct ufs_hba *hba,
147 const union ufs_crypto_cfg_entry *cfg,
150 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
151 union ufs_crypto_cap_entry cap;
153 cfg->config_enable & UFS_CRYPTO_CONFIGURATION_ENABLE;
155 /* Only AES-256-XTS has been tested so far. */
156 cap = hba->crypto_cap_array[cfg->crypto_cap_idx];
157 if (cap.algorithm_id != UFS_CRYPTO_ALG_AES_XTS ||
158 cap.key_size != UFS_CRYPTO_KEY_SIZE_256)
162 return qcom_ice_program_key(host->ice,
163 QCOM_ICE_CRYPTO_ALG_AES_XTS,
164 QCOM_ICE_CRYPTO_KEY_SIZE_256,
166 cfg->data_unit_size, slot);
168 return qcom_ice_evict_key(host->ice, slot);
173 #define ufs_qcom_ice_program_key NULL
175 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host *host)
179 static int ufs_qcom_ice_init(struct ufs_qcom_host *host)
184 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host *host)
189 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host *host)
195 static void ufs_qcom_disable_lane_clks(struct ufs_qcom_host *host)
197 if (!host->is_lane_clks_enabled)
200 clk_bulk_disable_unprepare(host->num_clks, host->clks);
202 host->is_lane_clks_enabled = false;
205 static int ufs_qcom_enable_lane_clks(struct ufs_qcom_host *host)
209 err = clk_bulk_prepare_enable(host->num_clks, host->clks);
213 host->is_lane_clks_enabled = true;
218 static int ufs_qcom_init_lane_clks(struct ufs_qcom_host *host)
221 struct device *dev = host->hba->dev;
223 if (has_acpi_companion(dev))
226 err = devm_clk_bulk_get_all(dev, &host->clks);
230 host->num_clks = err;
235 static int ufs_qcom_check_hibern8(struct ufs_hba *hba)
239 unsigned long timeout = jiffies + msecs_to_jiffies(HBRN8_POLL_TOUT_MS);
242 err = ufshcd_dme_get(hba,
243 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
244 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
246 if (err || tx_fsm_val == TX_FSM_HIBERN8)
249 /* sleep for max. 200us */
250 usleep_range(100, 200);
251 } while (time_before(jiffies, timeout));
254 * we might have scheduled out for long during polling so
255 * check the state again.
257 if (time_after(jiffies, timeout))
258 err = ufshcd_dme_get(hba,
259 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
260 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
264 dev_err(hba->dev, "%s: unable to get TX_FSM_STATE, err %d\n",
266 } else if (tx_fsm_val != TX_FSM_HIBERN8) {
268 dev_err(hba->dev, "%s: invalid TX_FSM_STATE = %d\n",
275 static void ufs_qcom_select_unipro_mode(struct ufs_qcom_host *host)
277 ufshcd_rmwl(host->hba, QUNIPRO_SEL, QUNIPRO_SEL, REG_UFS_CFG1);
279 if (host->hw_ver.major >= 0x05)
280 ufshcd_rmwl(host->hba, QUNIPRO_G4_SEL, 0, REG_UFS_CFG0);
282 /* make sure above configuration is applied before we return */
287 * ufs_qcom_host_reset - reset host controller and PHY
289 static int ufs_qcom_host_reset(struct ufs_hba *hba)
292 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
295 if (!host->core_reset)
298 reenable_intr = hba->is_irq_enabled;
299 ufshcd_disable_irq(hba);
301 ret = reset_control_assert(host->core_reset);
303 dev_err(hba->dev, "%s: core_reset assert failed, err = %d\n",
309 * The hardware requirement for delay between assert/deassert
310 * is at least 3-4 sleep clock (32.7KHz) cycles, which comes to
311 * ~125us (4/32768). To be on the safe side add 200us delay.
313 usleep_range(200, 210);
315 ret = reset_control_deassert(host->core_reset);
317 dev_err(hba->dev, "%s: core_reset deassert failed, err = %d\n",
322 usleep_range(1000, 1100);
325 ufshcd_enable_irq(hba);
330 static u32 ufs_qcom_get_hs_gear(struct ufs_hba *hba)
332 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
334 if (host->hw_ver.major >= 0x4)
335 return UFS_QCOM_MAX_GEAR(ufshcd_readl(hba, REG_UFS_PARAM0));
337 /* Default is HS-G3 */
341 static int ufs_qcom_power_up_sequence(struct ufs_hba *hba)
343 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
344 struct ufs_host_params *host_params = &host->host_params;
345 struct phy *phy = host->generic_phy;
350 * HW ver 5 can only support up to HS-G5 Rate-A due to HW limitations.
351 * If the HS-G5 PHY gear is used, update host_params->hs_rate to Rate-A,
352 * so that the subsequent power mode change shall stick to Rate-A.
354 if (host->hw_ver.major == 0x5) {
355 if (host->phy_gear == UFS_HS_G5)
356 host_params->hs_rate = PA_HS_MODE_A;
358 host_params->hs_rate = PA_HS_MODE_B;
361 mode = host_params->hs_rate == PA_HS_MODE_B ? PHY_MODE_UFS_HS_B : PHY_MODE_UFS_HS_A;
363 /* Reset UFS Host Controller and PHY */
364 ret = ufs_qcom_host_reset(hba);
368 /* phy initialization - calibrate the phy */
371 dev_err(hba->dev, "%s: phy init failed, ret = %d\n",
376 ret = phy_set_mode_ext(phy, mode, host->phy_gear);
378 goto out_disable_phy;
380 /* power on phy - start serdes and phy's power and clocks */
381 ret = phy_power_on(phy);
383 dev_err(hba->dev, "%s: phy power on failed, ret = %d\n",
385 goto out_disable_phy;
388 ufs_qcom_select_unipro_mode(host);
399 * The UTP controller has a number of internal clock gating cells (CGCs).
400 * Internal hardware sub-modules within the UTP controller control the CGCs.
401 * Hardware CGCs disable the clock to inactivate UTP sub-modules not involved
402 * in a specific operation, UTP controller CGCs are by default disabled and
403 * this function enables them (after every UFS link startup) to save some power
406 static void ufs_qcom_enable_hw_clk_gating(struct ufs_hba *hba)
408 ufshcd_rmwl(hba, REG_UFS_CFG2_CGC_EN_ALL, REG_UFS_CFG2_CGC_EN_ALL,
411 /* Ensure that HW clock gating is enabled before next operations */
415 static int ufs_qcom_hce_enable_notify(struct ufs_hba *hba,
416 enum ufs_notify_change_status status)
418 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
423 err = ufs_qcom_power_up_sequence(hba);
428 * The PHY PLL output is the source of tx/rx lane symbol
429 * clocks, hence, enable the lane clocks only after PHY
432 err = ufs_qcom_enable_lane_clks(host);
435 /* check if UFS PHY moved from DISABLED to HIBERN8 */
436 err = ufs_qcom_check_hibern8(hba);
437 ufs_qcom_enable_hw_clk_gating(hba);
438 ufs_qcom_ice_enable(host);
441 dev_err(hba->dev, "%s: invalid status %d\n", __func__, status);
449 * ufs_qcom_cfg_timers - Configure ufs qcom cfg timers
451 * @hba: host controller instance
452 * @gear: Current operating gear
453 * @hs: current power mode
454 * @rate: current operating rate (A or B)
455 * @update_link_startup_timer: indicate if link_start ongoing
456 * @is_pre_scale_up: flag to check if pre scale up condition.
457 * Return: zero for success and non-zero in case of a failure.
459 static int ufs_qcom_cfg_timers(struct ufs_hba *hba, u32 gear,
460 u32 hs, u32 rate, bool update_link_startup_timer,
461 bool is_pre_scale_up)
463 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
464 struct ufs_clk_info *clki;
465 unsigned long core_clk_rate = 0;
466 u32 core_clk_cycles_per_us;
469 * UTP controller uses SYS1CLK_1US_REG register for Interrupt
471 * It is mandatory to write SYS1CLK_1US_REG register on UFS host
472 * controller V4.0.0 onwards.
474 if (host->hw_ver.major < 4 && !ufshcd_is_intr_aggr_allowed(hba))
478 dev_err(hba->dev, "%s: invalid gear = %d\n", __func__, gear);
482 list_for_each_entry(clki, &hba->clk_list_head, list) {
483 if (!strcmp(clki->name, "core_clk")) {
485 core_clk_rate = clki->max_freq;
487 core_clk_rate = clk_get_rate(clki->clk);
493 /* If frequency is smaller than 1MHz, set to 1MHz */
494 if (core_clk_rate < DEFAULT_CLK_RATE_HZ)
495 core_clk_rate = DEFAULT_CLK_RATE_HZ;
497 core_clk_cycles_per_us = core_clk_rate / USEC_PER_SEC;
498 if (ufshcd_readl(hba, REG_UFS_SYS1CLK_1US) != core_clk_cycles_per_us) {
499 ufshcd_writel(hba, core_clk_cycles_per_us, REG_UFS_SYS1CLK_1US);
501 * make sure above write gets applied before we return from
510 static int ufs_qcom_link_startup_notify(struct ufs_hba *hba,
511 enum ufs_notify_change_status status)
517 if (ufs_qcom_cfg_timers(hba, UFS_PWM_G1, SLOWAUTO_MODE,
519 dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
524 err = ufs_qcom_set_core_clk_ctrl(hba, true);
526 dev_err(hba->dev, "cfg core clk ctrl failed\n");
528 * Some UFS devices (and may be host) have issues if LCC is
529 * enabled. So we are setting PA_Local_TX_LCC_Enable to 0
530 * before link startup which will make sure that both host
531 * and device TX LCC are disabled once link startup is
534 if (ufshcd_get_local_unipro_ver(hba) != UFS_UNIPRO_VER_1_41)
535 err = ufshcd_disable_host_tx_lcc(hba);
545 static void ufs_qcom_device_reset_ctrl(struct ufs_hba *hba, bool asserted)
547 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
549 /* reset gpio is optional */
550 if (!host->device_reset)
553 gpiod_set_value_cansleep(host->device_reset, asserted);
556 static int ufs_qcom_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op,
557 enum ufs_notify_change_status status)
559 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
560 struct phy *phy = host->generic_phy;
562 if (status == PRE_CHANGE)
565 if (ufs_qcom_is_link_off(hba)) {
567 * Disable the tx/rx lane symbol clocks before PHY is
568 * powered down as the PLL source should be disabled
569 * after downstream clocks are disabled.
571 ufs_qcom_disable_lane_clks(host);
574 /* reset the connected UFS device during power down */
575 ufs_qcom_device_reset_ctrl(hba, true);
577 } else if (!ufs_qcom_is_link_active(hba)) {
578 ufs_qcom_disable_lane_clks(host);
581 return ufs_qcom_ice_suspend(host);
584 static int ufs_qcom_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
586 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
587 struct phy *phy = host->generic_phy;
590 if (ufs_qcom_is_link_off(hba)) {
591 err = phy_power_on(phy);
593 dev_err(hba->dev, "%s: failed PHY power on: %d\n",
598 err = ufs_qcom_enable_lane_clks(host);
602 } else if (!ufs_qcom_is_link_active(hba)) {
603 err = ufs_qcom_enable_lane_clks(host);
608 return ufs_qcom_ice_resume(host);
611 static void ufs_qcom_dev_ref_clk_ctrl(struct ufs_qcom_host *host, bool enable)
613 if (host->dev_ref_clk_ctrl_mmio &&
614 (enable ^ host->is_dev_ref_clk_enabled)) {
615 u32 temp = readl_relaxed(host->dev_ref_clk_ctrl_mmio);
618 temp |= host->dev_ref_clk_en_mask;
620 temp &= ~host->dev_ref_clk_en_mask;
623 * If we are here to disable this clock it might be immediately
624 * after entering into hibern8 in which case we need to make
625 * sure that device ref_clk is active for specific time after
629 unsigned long gating_wait;
631 gating_wait = host->hba->dev_info.clk_gating_wait_us;
636 * bRefClkGatingWaitTime defines the minimum
637 * time for which the reference clock is
638 * required by device during transition from
639 * HS-MODE to LS-MODE or HIBERN8 state. Give it
640 * more delay to be on the safe side.
643 usleep_range(gating_wait, gating_wait + 10);
647 writel_relaxed(temp, host->dev_ref_clk_ctrl_mmio);
650 * Make sure the write to ref_clk reaches the destination and
651 * not stored in a Write Buffer (WB).
653 readl(host->dev_ref_clk_ctrl_mmio);
656 * If we call hibern8 exit after this, we need to make sure that
657 * device ref_clk is stable for at least 1us before the hibern8
663 host->is_dev_ref_clk_enabled = enable;
667 static int ufs_qcom_icc_set_bw(struct ufs_qcom_host *host, u32 mem_bw, u32 cfg_bw)
669 struct device *dev = host->hba->dev;
672 ret = icc_set_bw(host->icc_ddr, 0, mem_bw);
674 dev_err(dev, "failed to set bandwidth request: %d\n", ret);
678 ret = icc_set_bw(host->icc_cpu, 0, cfg_bw);
680 dev_err(dev, "failed to set bandwidth request: %d\n", ret);
687 static struct __ufs_qcom_bw_table ufs_qcom_get_bw_table(struct ufs_qcom_host *host)
689 struct ufs_pa_layer_attr *p = &host->dev_req_params;
690 int gear = max_t(u32, p->gear_rx, p->gear_tx);
691 int lane = max_t(u32, p->lane_rx, p->lane_tx);
693 if (ufshcd_is_hs_mode(p)) {
694 if (p->hs_rate == PA_HS_MODE_B)
695 return ufs_qcom_bw_table[MODE_HS_RB][gear][lane];
697 return ufs_qcom_bw_table[MODE_HS_RA][gear][lane];
699 return ufs_qcom_bw_table[MODE_PWM][gear][lane];
703 static int ufs_qcom_icc_update_bw(struct ufs_qcom_host *host)
705 struct __ufs_qcom_bw_table bw_table;
707 bw_table = ufs_qcom_get_bw_table(host);
709 return ufs_qcom_icc_set_bw(host, bw_table.mem_bw, bw_table.cfg_bw);
712 static int ufs_qcom_pwr_change_notify(struct ufs_hba *hba,
713 enum ufs_notify_change_status status,
714 struct ufs_pa_layer_attr *dev_max_params,
715 struct ufs_pa_layer_attr *dev_req_params)
717 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
718 struct ufs_host_params *host_params = &host->host_params;
721 if (!dev_req_params) {
722 pr_err("%s: incoming dev_req_params is NULL\n", __func__);
728 ret = ufshcd_negotiate_pwr_params(host_params, dev_max_params, dev_req_params);
730 dev_err(hba->dev, "%s: failed to determine capabilities\n",
736 * During UFS driver probe, always update the PHY gear to match the negotiated
737 * gear, so that, if quirk UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH is enabled,
738 * the second init can program the optimal PHY settings. This allows one to start
739 * the first init with either the minimum or the maximum support gear.
741 if (hba->ufshcd_state == UFSHCD_STATE_RESET)
742 host->phy_gear = dev_req_params->gear_tx;
744 /* enable the device ref clock before changing to HS mode */
745 if (!ufshcd_is_hs_mode(&hba->pwr_info) &&
746 ufshcd_is_hs_mode(dev_req_params))
747 ufs_qcom_dev_ref_clk_ctrl(host, true);
749 if (host->hw_ver.major >= 0x4) {
750 ufshcd_dme_configure_adapt(hba,
751 dev_req_params->gear_tx,
756 if (ufs_qcom_cfg_timers(hba, dev_req_params->gear_rx,
757 dev_req_params->pwr_rx,
758 dev_req_params->hs_rate, false, false)) {
759 dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
762 * we return error code at the end of the routine,
763 * but continue to configure UFS_PHY_TX_LANE_ENABLE
764 * and bus voting as usual
769 /* cache the power mode parameters to use internally */
770 memcpy(&host->dev_req_params,
771 dev_req_params, sizeof(*dev_req_params));
773 ufs_qcom_icc_update_bw(host);
775 /* disable the device ref clock if entered PWM mode */
776 if (ufshcd_is_hs_mode(&hba->pwr_info) &&
777 !ufshcd_is_hs_mode(dev_req_params))
778 ufs_qcom_dev_ref_clk_ctrl(host, false);
788 static int ufs_qcom_quirk_host_pa_saveconfigtime(struct ufs_hba *hba)
791 u32 pa_vs_config_reg1;
793 err = ufshcd_dme_get(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
798 /* Allow extension of MSB bits of PA_SaveConfigTime attribute */
799 return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
800 (pa_vs_config_reg1 | (1 << 12)));
803 static int ufs_qcom_apply_dev_quirks(struct ufs_hba *hba)
807 if (hba->dev_quirks & UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME)
808 err = ufs_qcom_quirk_host_pa_saveconfigtime(hba);
810 if (hba->dev_info.wmanufacturerid == UFS_VENDOR_WDC)
811 hba->dev_quirks |= UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE;
816 static u32 ufs_qcom_get_ufs_hci_version(struct ufs_hba *hba)
818 return ufshci_version(2, 0);
822 * ufs_qcom_advertise_quirks - advertise the known QCOM UFS controller quirks
823 * @hba: host controller instance
825 * QCOM UFS host controller might have some non standard behaviours (quirks)
826 * than what is specified by UFSHCI specification. Advertise all such
827 * quirks to standard UFS host controller driver so standard takes them into
830 static void ufs_qcom_advertise_quirks(struct ufs_hba *hba)
832 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
834 if (host->hw_ver.major == 0x2)
835 hba->quirks |= UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION;
837 if (host->hw_ver.major > 0x3)
838 hba->quirks |= UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH;
841 static void ufs_qcom_set_phy_gear(struct ufs_qcom_host *host)
843 struct ufs_host_params *host_params = &host->host_params;
846 host->phy_gear = host_params->hs_tx_gear;
848 if (host->hw_ver.major < 0x4) {
850 * For controllers whose major HW version is < 4, power up the
851 * PHY using minimum supported gear (UFS_HS_G2). Switching to
852 * max gear will be performed during reinit if supported.
853 * For newer controllers, whose major HW version is >= 4, power
854 * up the PHY using max supported gear.
856 host->phy_gear = UFS_HS_G2;
857 } else if (host->hw_ver.major >= 0x5) {
858 val = ufshcd_readl(host->hba, REG_UFS_DEBUG_SPARE_CFG);
859 dev_major = FIELD_GET(UFS_DEV_VER_MAJOR_MASK, val);
862 * Since the UFS device version is populated, let's remove the
863 * REINIT quirk as the negotiated gear won't change during boot.
864 * So there is no need to do reinit.
866 if (dev_major != 0x0)
867 host->hba->quirks &= ~UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH;
870 * For UFS 3.1 device and older, power up the PHY using HS-G4
871 * PHY gear to save power.
873 if (dev_major > 0x0 && dev_major < 0x4)
874 host->phy_gear = UFS_HS_G4;
878 static void ufs_qcom_set_host_params(struct ufs_hba *hba)
880 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
881 struct ufs_host_params *host_params = &host->host_params;
883 ufshcd_init_host_params(host_params);
885 /* This driver only supports symmetic gear setting i.e., hs_tx_gear == hs_rx_gear */
886 host_params->hs_tx_gear = host_params->hs_rx_gear = ufs_qcom_get_hs_gear(hba);
889 static void ufs_qcom_set_caps(struct ufs_hba *hba)
891 hba->caps |= UFSHCD_CAP_CLK_GATING | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
892 hba->caps |= UFSHCD_CAP_CLK_SCALING | UFSHCD_CAP_WB_WITH_CLK_SCALING;
893 hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
894 hba->caps |= UFSHCD_CAP_WB_EN;
895 hba->caps |= UFSHCD_CAP_AGGR_POWER_COLLAPSE;
896 hba->caps |= UFSHCD_CAP_RPM_AUTOSUSPEND;
900 * ufs_qcom_setup_clocks - enables/disable clocks
901 * @hba: host controller instance
902 * @on: If true, enable clocks else disable them.
903 * @status: PRE_CHANGE or POST_CHANGE notify
905 * Return: 0 on success, non-zero on failure.
907 static int ufs_qcom_setup_clocks(struct ufs_hba *hba, bool on,
908 enum ufs_notify_change_status status)
910 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
913 * In case ufs_qcom_init() is not yet done, simply ignore.
914 * This ufs_qcom_setup_clocks() shall be called from
915 * ufs_qcom_init() after init is done.
923 ufs_qcom_icc_update_bw(host);
925 if (!ufs_qcom_is_link_active(hba)) {
926 /* disable device ref_clk */
927 ufs_qcom_dev_ref_clk_ctrl(host, false);
933 /* enable the device ref clock for HS mode*/
934 if (ufshcd_is_hs_mode(&hba->pwr_info))
935 ufs_qcom_dev_ref_clk_ctrl(host, true);
937 ufs_qcom_icc_set_bw(host, ufs_qcom_bw_table[MODE_MIN][0][0].mem_bw,
938 ufs_qcom_bw_table[MODE_MIN][0][0].cfg_bw);
947 ufs_qcom_reset_assert(struct reset_controller_dev *rcdev, unsigned long id)
949 struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
951 ufs_qcom_assert_reset(host->hba);
952 /* provide 1ms delay to let the reset pulse propagate. */
953 usleep_range(1000, 1100);
958 ufs_qcom_reset_deassert(struct reset_controller_dev *rcdev, unsigned long id)
960 struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
962 ufs_qcom_deassert_reset(host->hba);
965 * after reset deassertion, phy will need all ref clocks,
966 * voltage, current to settle down before starting serdes.
968 usleep_range(1000, 1100);
972 static const struct reset_control_ops ufs_qcom_reset_ops = {
973 .assert = ufs_qcom_reset_assert,
974 .deassert = ufs_qcom_reset_deassert,
977 static int ufs_qcom_icc_init(struct ufs_qcom_host *host)
979 struct device *dev = host->hba->dev;
982 host->icc_ddr = devm_of_icc_get(dev, "ufs-ddr");
983 if (IS_ERR(host->icc_ddr))
984 return dev_err_probe(dev, PTR_ERR(host->icc_ddr),
985 "failed to acquire interconnect path\n");
987 host->icc_cpu = devm_of_icc_get(dev, "cpu-ufs");
988 if (IS_ERR(host->icc_cpu))
989 return dev_err_probe(dev, PTR_ERR(host->icc_cpu),
990 "failed to acquire interconnect path\n");
993 * Set Maximum bandwidth vote before initializing the UFS controller and
994 * device. Ideally, a minimal interconnect vote would suffice for the
995 * initialization, but a max vote would allow faster initialization.
997 ret = ufs_qcom_icc_set_bw(host, ufs_qcom_bw_table[MODE_MAX][0][0].mem_bw,
998 ufs_qcom_bw_table[MODE_MAX][0][0].cfg_bw);
1000 return dev_err_probe(dev, ret, "failed to set bandwidth request\n");
1006 * ufs_qcom_init - bind phy with controller
1007 * @hba: host controller instance
1009 * Binds PHY with controller and powers up PHY enabling clocks
1012 * Return: -EPROBE_DEFER if binding fails, returns negative error
1013 * on phy power up failure and returns zero on success.
1015 static int ufs_qcom_init(struct ufs_hba *hba)
1018 struct device *dev = hba->dev;
1019 struct ufs_qcom_host *host;
1020 struct ufs_clk_info *clki;
1022 host = devm_kzalloc(dev, sizeof(*host), GFP_KERNEL);
1026 /* Make a two way bind between the qcom host and the hba */
1028 ufshcd_set_variant(hba, host);
1030 /* Setup the optional reset control of HCI */
1031 host->core_reset = devm_reset_control_get_optional(hba->dev, "rst");
1032 if (IS_ERR(host->core_reset)) {
1033 err = dev_err_probe(dev, PTR_ERR(host->core_reset),
1034 "Failed to get reset control\n");
1035 goto out_variant_clear;
1038 /* Fire up the reset controller. Failure here is non-fatal. */
1039 host->rcdev.of_node = dev->of_node;
1040 host->rcdev.ops = &ufs_qcom_reset_ops;
1041 host->rcdev.owner = dev->driver->owner;
1042 host->rcdev.nr_resets = 1;
1043 err = devm_reset_controller_register(dev, &host->rcdev);
1045 dev_warn(dev, "Failed to register reset controller\n");
1047 if (!has_acpi_companion(dev)) {
1048 host->generic_phy = devm_phy_get(dev, "ufsphy");
1049 if (IS_ERR(host->generic_phy)) {
1050 err = dev_err_probe(dev, PTR_ERR(host->generic_phy), "Failed to get PHY\n");
1051 goto out_variant_clear;
1055 err = ufs_qcom_icc_init(host);
1057 goto out_variant_clear;
1059 host->device_reset = devm_gpiod_get_optional(dev, "reset",
1061 if (IS_ERR(host->device_reset)) {
1062 err = dev_err_probe(dev, PTR_ERR(host->device_reset),
1063 "Failed to acquire device reset gpio\n");
1064 goto out_variant_clear;
1067 ufs_qcom_get_controller_revision(hba, &host->hw_ver.major,
1068 &host->hw_ver.minor, &host->hw_ver.step);
1070 host->dev_ref_clk_ctrl_mmio = hba->mmio_base + REG_UFS_CFG1;
1071 host->dev_ref_clk_en_mask = BIT(26);
1073 list_for_each_entry(clki, &hba->clk_list_head, list) {
1074 if (!strcmp(clki->name, "core_clk_unipro"))
1075 clki->keep_link_active = true;
1078 err = ufs_qcom_init_lane_clks(host);
1080 goto out_variant_clear;
1082 ufs_qcom_set_caps(hba);
1083 ufs_qcom_advertise_quirks(hba);
1084 ufs_qcom_set_host_params(hba);
1085 ufs_qcom_set_phy_gear(host);
1087 err = ufs_qcom_ice_init(host);
1089 goto out_variant_clear;
1091 ufs_qcom_setup_clocks(hba, true, POST_CHANGE);
1093 ufs_qcom_get_default_testbus_cfg(host);
1094 err = ufs_qcom_testbus_config(host);
1096 /* Failure is non-fatal */
1097 dev_warn(dev, "%s: failed to configure the testbus %d\n",
1103 ufshcd_set_variant(hba, NULL);
1108 static void ufs_qcom_exit(struct ufs_hba *hba)
1110 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1112 ufs_qcom_disable_lane_clks(host);
1113 phy_power_off(host->generic_phy);
1114 phy_exit(host->generic_phy);
1118 * ufs_qcom_set_clk_40ns_cycles - Configure 40ns clk cycles
1120 * @hba: host controller instance
1121 * @cycles_in_1us: No of cycles in 1us to be configured
1123 * Returns error if dme get/set configuration for 40ns fails
1124 * and returns zero on success.
1126 static int ufs_qcom_set_clk_40ns_cycles(struct ufs_hba *hba,
1129 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1135 * UFS host controller V4.0.0 onwards needs to program
1136 * PA_VS_CORE_CLK_40NS_CYCLES attribute per programmed
1137 * frequency of unipro core clk of UFS host controller.
1139 if (host->hw_ver.major < 4)
1143 * Generic formulae for cycles_in_40ns = (freq_unipro/25) is not
1144 * applicable for all frequencies. For ex: ceil(37.5 MHz/25) will
1145 * be 2 and ceil(403 MHZ/25) will be 17 whereas Hardware
1146 * specification expect to be 16. Hence use exact hardware spec
1147 * mandated value for cycles_in_40ns instead of calculating using
1150 switch (cycles_in_1us) {
1151 case UNIPRO_CORE_CLK_FREQ_403_MHZ:
1152 cycles_in_40ns = 16;
1154 case UNIPRO_CORE_CLK_FREQ_300_MHZ:
1155 cycles_in_40ns = 12;
1157 case UNIPRO_CORE_CLK_FREQ_201_5_MHZ:
1160 case UNIPRO_CORE_CLK_FREQ_150_MHZ:
1163 case UNIPRO_CORE_CLK_FREQ_100_MHZ:
1166 case UNIPRO_CORE_CLK_FREQ_75_MHZ:
1169 case UNIPRO_CORE_CLK_FREQ_37_5_MHZ:
1173 dev_err(hba->dev, "UNIPRO clk freq %u MHz not supported\n",
1178 err = ufshcd_dme_get(hba, UIC_ARG_MIB(PA_VS_CORE_CLK_40NS_CYCLES), ®);
1182 reg &= ~PA_VS_CORE_CLK_40NS_CYCLES_MASK;
1183 reg |= cycles_in_40ns;
1185 return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_VS_CORE_CLK_40NS_CYCLES), reg);
1188 static int ufs_qcom_set_core_clk_ctrl(struct ufs_hba *hba, bool is_scale_up)
1190 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1191 struct list_head *head = &hba->clk_list_head;
1192 struct ufs_clk_info *clki;
1193 u32 cycles_in_1us = 0;
1194 u32 core_clk_ctrl_reg;
1197 list_for_each_entry(clki, head, list) {
1198 if (!IS_ERR_OR_NULL(clki->clk) &&
1199 !strcmp(clki->name, "core_clk_unipro")) {
1201 cycles_in_1us = ceil(clki->max_freq, (1000 * 1000));
1203 cycles_in_1us = ceil(clk_get_rate(clki->clk), (1000 * 1000));
1208 err = ufshcd_dme_get(hba,
1209 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1210 &core_clk_ctrl_reg);
1214 /* Bit mask is different for UFS host controller V4.0.0 onwards */
1215 if (host->hw_ver.major >= 4) {
1216 if (!FIELD_FIT(CLK_1US_CYCLES_MASK_V4, cycles_in_1us))
1218 core_clk_ctrl_reg &= ~CLK_1US_CYCLES_MASK_V4;
1219 core_clk_ctrl_reg |= FIELD_PREP(CLK_1US_CYCLES_MASK_V4, cycles_in_1us);
1221 if (!FIELD_FIT(CLK_1US_CYCLES_MASK, cycles_in_1us))
1223 core_clk_ctrl_reg &= ~CLK_1US_CYCLES_MASK;
1224 core_clk_ctrl_reg |= FIELD_PREP(CLK_1US_CYCLES_MASK, cycles_in_1us);
1227 /* Clear CORE_CLK_DIV_EN */
1228 core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1230 err = ufshcd_dme_set(hba,
1231 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1236 /* Configure unipro core clk 40ns attribute */
1237 return ufs_qcom_set_clk_40ns_cycles(hba, cycles_in_1us);
1240 static int ufs_qcom_clk_scale_up_pre_change(struct ufs_hba *hba)
1242 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1243 struct ufs_pa_layer_attr *attr = &host->dev_req_params;
1246 ret = ufs_qcom_cfg_timers(hba, attr->gear_rx, attr->pwr_rx,
1247 attr->hs_rate, false, true);
1249 dev_err(hba->dev, "%s ufs cfg timer failed\n", __func__);
1252 /* set unipro core clock attributes and clear clock divider */
1253 return ufs_qcom_set_core_clk_ctrl(hba, true);
1256 static int ufs_qcom_clk_scale_up_post_change(struct ufs_hba *hba)
1261 static int ufs_qcom_clk_scale_down_pre_change(struct ufs_hba *hba)
1264 u32 core_clk_ctrl_reg;
1266 err = ufshcd_dme_get(hba,
1267 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1268 &core_clk_ctrl_reg);
1270 /* make sure CORE_CLK_DIV_EN is cleared */
1272 (core_clk_ctrl_reg & DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT)) {
1273 core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1274 err = ufshcd_dme_set(hba,
1275 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1282 static int ufs_qcom_clk_scale_down_post_change(struct ufs_hba *hba)
1284 /* set unipro core clock attributes and clear clock divider */
1285 return ufs_qcom_set_core_clk_ctrl(hba, false);
1288 static int ufs_qcom_clk_scale_notify(struct ufs_hba *hba,
1289 bool scale_up, enum ufs_notify_change_status status)
1291 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1294 /* check the host controller state before sending hibern8 cmd */
1295 if (!ufshcd_is_hba_active(hba))
1298 if (status == PRE_CHANGE) {
1299 err = ufshcd_uic_hibern8_enter(hba);
1303 err = ufs_qcom_clk_scale_up_pre_change(hba);
1305 err = ufs_qcom_clk_scale_down_pre_change(hba);
1308 ufshcd_uic_hibern8_exit(hba);
1313 err = ufs_qcom_clk_scale_up_post_change(hba);
1315 err = ufs_qcom_clk_scale_down_post_change(hba);
1319 ufshcd_uic_hibern8_exit(hba);
1323 ufs_qcom_icc_update_bw(host);
1324 ufshcd_uic_hibern8_exit(hba);
1330 static void ufs_qcom_enable_test_bus(struct ufs_qcom_host *host)
1332 ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN,
1333 UFS_REG_TEST_BUS_EN, REG_UFS_CFG1);
1334 ufshcd_rmwl(host->hba, TEST_BUS_EN, TEST_BUS_EN, REG_UFS_CFG1);
1337 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host)
1339 /* provide a legal default configuration */
1340 host->testbus.select_major = TSTBUS_UNIPRO;
1341 host->testbus.select_minor = 37;
1344 static bool ufs_qcom_testbus_cfg_is_ok(struct ufs_qcom_host *host)
1346 if (host->testbus.select_major >= TSTBUS_MAX) {
1347 dev_err(host->hba->dev,
1348 "%s: UFS_CFG1[TEST_BUS_SEL} may not equal 0x%05X\n",
1349 __func__, host->testbus.select_major);
1356 int ufs_qcom_testbus_config(struct ufs_qcom_host *host)
1360 u32 mask = TEST_BUS_SUB_SEL_MASK;
1365 if (!ufs_qcom_testbus_cfg_is_ok(host))
1368 switch (host->testbus.select_major) {
1370 reg = UFS_TEST_BUS_CTRL_0;
1374 reg = UFS_TEST_BUS_CTRL_0;
1378 reg = UFS_TEST_BUS_CTRL_0;
1382 reg = UFS_TEST_BUS_CTRL_0;
1386 reg = UFS_TEST_BUS_CTRL_1;
1390 reg = UFS_TEST_BUS_CTRL_1;
1394 reg = UFS_TEST_BUS_CTRL_1;
1398 reg = UFS_TEST_BUS_CTRL_1;
1401 case TSTBUS_WRAPPER:
1402 reg = UFS_TEST_BUS_CTRL_2;
1405 case TSTBUS_COMBINED:
1406 reg = UFS_TEST_BUS_CTRL_2;
1409 case TSTBUS_UTP_HCI:
1410 reg = UFS_TEST_BUS_CTRL_2;
1414 reg = UFS_UNIPRO_CFG;
1419 * No need for a default case, since
1420 * ufs_qcom_testbus_cfg_is_ok() checks that the configuration
1425 ufshcd_rmwl(host->hba, TEST_BUS_SEL,
1426 (u32)host->testbus.select_major << 19,
1428 ufshcd_rmwl(host->hba, mask,
1429 (u32)host->testbus.select_minor << offset,
1431 ufs_qcom_enable_test_bus(host);
1433 * Make sure the test bus configuration is
1434 * committed before returning.
1441 static void ufs_qcom_dump_dbg_regs(struct ufs_hba *hba)
1444 struct ufs_qcom_host *host;
1446 host = ufshcd_get_variant(hba);
1448 ufshcd_dump_regs(hba, REG_UFS_SYS1CLK_1US, 16 * 4,
1449 "HCI Vendor Specific Registers ");
1451 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_REG_OCSC);
1452 ufshcd_dump_regs(hba, reg, 44 * 4, "UFS_UFS_DBG_RD_REG_OCSC ");
1454 reg = ufshcd_readl(hba, REG_UFS_CFG1);
1455 reg |= UTP_DBG_RAMS_EN;
1456 ufshcd_writel(hba, reg, REG_UFS_CFG1);
1458 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_EDTL_RAM);
1459 ufshcd_dump_regs(hba, reg, 32 * 4, "UFS_UFS_DBG_RD_EDTL_RAM ");
1461 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_DESC_RAM);
1462 ufshcd_dump_regs(hba, reg, 128 * 4, "UFS_UFS_DBG_RD_DESC_RAM ");
1464 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_PRDT_RAM);
1465 ufshcd_dump_regs(hba, reg, 64 * 4, "UFS_UFS_DBG_RD_PRDT_RAM ");
1467 /* clear bit 17 - UTP_DBG_RAMS_EN */
1468 ufshcd_rmwl(hba, UTP_DBG_RAMS_EN, 0, REG_UFS_CFG1);
1470 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UAWM);
1471 ufshcd_dump_regs(hba, reg, 4 * 4, "UFS_DBG_RD_REG_UAWM ");
1473 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UARM);
1474 ufshcd_dump_regs(hba, reg, 4 * 4, "UFS_DBG_RD_REG_UARM ");
1476 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TXUC);
1477 ufshcd_dump_regs(hba, reg, 48 * 4, "UFS_DBG_RD_REG_TXUC ");
1479 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_RXUC);
1480 ufshcd_dump_regs(hba, reg, 27 * 4, "UFS_DBG_RD_REG_RXUC ");
1482 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_DFC);
1483 ufshcd_dump_regs(hba, reg, 19 * 4, "UFS_DBG_RD_REG_DFC ");
1485 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TRLUT);
1486 ufshcd_dump_regs(hba, reg, 34 * 4, "UFS_DBG_RD_REG_TRLUT ");
1488 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TMRLUT);
1489 ufshcd_dump_regs(hba, reg, 9 * 4, "UFS_DBG_RD_REG_TMRLUT ");
1493 * ufs_qcom_device_reset() - toggle the (optional) device reset line
1494 * @hba: per-adapter instance
1496 * Toggles the (optional) reset line to reset the attached device.
1498 static int ufs_qcom_device_reset(struct ufs_hba *hba)
1500 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1502 /* reset gpio is optional */
1503 if (!host->device_reset)
1507 * The UFS device shall detect reset pulses of 1us, sleep for 10us to
1508 * be on the safe side.
1510 ufs_qcom_device_reset_ctrl(hba, true);
1511 usleep_range(10, 15);
1513 ufs_qcom_device_reset_ctrl(hba, false);
1514 usleep_range(10, 15);
1519 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
1520 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1521 struct devfreq_dev_profile *p,
1522 struct devfreq_simple_ondemand_data *d)
1525 p->timer = DEVFREQ_TIMER_DELAYED;
1526 d->upthreshold = 70;
1527 d->downdifferential = 5;
1530 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1531 struct devfreq_dev_profile *p,
1532 struct devfreq_simple_ondemand_data *data)
1537 static void ufs_qcom_reinit_notify(struct ufs_hba *hba)
1539 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1541 phy_power_off(host->generic_phy);
1545 static const struct ufshcd_res_info ufs_res_info[RES_MAX] = {
1546 {.name = "ufs_mem",},
1548 /* Submission Queue DAO */
1549 {.name = "mcq_sqd",},
1550 /* Submission Queue Interrupt Status */
1551 {.name = "mcq_sqis",},
1552 /* Completion Queue DAO */
1553 {.name = "mcq_cqd",},
1554 /* Completion Queue Interrupt Status */
1555 {.name = "mcq_cqis",},
1556 /* MCQ vendor specific */
1557 {.name = "mcq_vs",},
1560 static int ufs_qcom_mcq_config_resource(struct ufs_hba *hba)
1562 struct platform_device *pdev = to_platform_device(hba->dev);
1563 struct ufshcd_res_info *res;
1564 struct resource *res_mem, *res_mcq;
1567 memcpy(hba->res, ufs_res_info, sizeof(ufs_res_info));
1569 for (i = 0; i < RES_MAX; i++) {
1571 res->resource = platform_get_resource_byname(pdev,
1574 if (!res->resource) {
1575 dev_info(hba->dev, "Resource %s not provided\n", res->name);
1579 } else if (i == RES_UFS) {
1580 res_mem = res->resource;
1581 res->base = hba->mmio_base;
1585 res->base = devm_ioremap_resource(hba->dev, res->resource);
1586 if (IS_ERR(res->base)) {
1587 dev_err(hba->dev, "Failed to map res %s, err=%d\n",
1588 res->name, (int)PTR_ERR(res->base));
1589 ret = PTR_ERR(res->base);
1595 /* MCQ resource provided in DT */
1596 res = &hba->res[RES_MCQ];
1597 /* Bail if MCQ resource is provided */
1601 /* Explicitly allocate MCQ resource from ufs_mem */
1602 res_mcq = devm_kzalloc(hba->dev, sizeof(*res_mcq), GFP_KERNEL);
1606 res_mcq->start = res_mem->start +
1607 MCQ_SQATTR_OFFSET(hba->mcq_capabilities);
1608 res_mcq->end = res_mcq->start + hba->nr_hw_queues * MCQ_QCFG_SIZE - 1;
1609 res_mcq->flags = res_mem->flags;
1610 res_mcq->name = "mcq";
1612 ret = insert_resource(&iomem_resource, res_mcq);
1614 dev_err(hba->dev, "Failed to insert MCQ resource, err=%d\n",
1619 res->base = devm_ioremap_resource(hba->dev, res_mcq);
1620 if (IS_ERR(res->base)) {
1621 dev_err(hba->dev, "MCQ registers mapping failed, err=%d\n",
1622 (int)PTR_ERR(res->base));
1623 ret = PTR_ERR(res->base);
1628 hba->mcq_base = res->base;
1632 remove_resource(res_mcq);
1636 static int ufs_qcom_op_runtime_config(struct ufs_hba *hba)
1638 struct ufshcd_res_info *mem_res, *sqdao_res;
1639 struct ufshcd_mcq_opr_info_t *opr;
1642 mem_res = &hba->res[RES_UFS];
1643 sqdao_res = &hba->res[RES_MCQ_SQD];
1645 if (!mem_res->base || !sqdao_res->base)
1648 for (i = 0; i < OPR_MAX; i++) {
1649 opr = &hba->mcq_opr[i];
1650 opr->offset = sqdao_res->resource->start -
1651 mem_res->resource->start + 0x40 * i;
1652 opr->stride = 0x100;
1653 opr->base = sqdao_res->base + 0x40 * i;
1659 static int ufs_qcom_get_hba_mac(struct ufs_hba *hba)
1661 /* Qualcomm HC supports up to 64 */
1662 return MAX_SUPP_MAC;
1665 static int ufs_qcom_get_outstanding_cqs(struct ufs_hba *hba,
1666 unsigned long *ocqs)
1668 struct ufshcd_res_info *mcq_vs_res = &hba->res[RES_MCQ_VS];
1670 if (!mcq_vs_res->base)
1673 *ocqs = readl(mcq_vs_res->base + UFS_MEM_CQIS_VS);
1678 static void ufs_qcom_write_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1680 struct device *dev = msi_desc_to_dev(desc);
1681 struct ufs_hba *hba = dev_get_drvdata(dev);
1683 ufshcd_mcq_config_esi(hba, msg);
1686 static irqreturn_t ufs_qcom_mcq_esi_handler(int irq, void *data)
1688 struct msi_desc *desc = data;
1689 struct device *dev = msi_desc_to_dev(desc);
1690 struct ufs_hba *hba = dev_get_drvdata(dev);
1691 u32 id = desc->msi_index;
1692 struct ufs_hw_queue *hwq = &hba->uhq[id];
1694 ufshcd_mcq_write_cqis(hba, 0x1, id);
1695 ufshcd_mcq_poll_cqe_lock(hba, hwq);
1700 static int ufs_qcom_config_esi(struct ufs_hba *hba)
1702 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1703 struct msi_desc *desc;
1704 struct msi_desc *failed_desc = NULL;
1707 if (host->esi_enabled)
1711 * 1. We only handle CQs as of now.
1712 * 2. Poll queues do not need ESI.
1714 nr_irqs = hba->nr_hw_queues - hba->nr_queues[HCTX_TYPE_POLL];
1715 ret = platform_msi_domain_alloc_irqs(hba->dev, nr_irqs,
1716 ufs_qcom_write_msi_msg);
1718 dev_err(hba->dev, "Failed to request Platform MSI %d\n", ret);
1722 msi_lock_descs(hba->dev);
1723 msi_for_each_desc(desc, hba->dev, MSI_DESC_ALL) {
1724 ret = devm_request_irq(hba->dev, desc->irq,
1725 ufs_qcom_mcq_esi_handler,
1726 IRQF_SHARED, "qcom-mcq-esi", desc);
1728 dev_err(hba->dev, "%s: Fail to request IRQ for %d, err = %d\n",
1729 __func__, desc->irq, ret);
1734 msi_unlock_descs(hba->dev);
1738 msi_lock_descs(hba->dev);
1739 msi_for_each_desc(desc, hba->dev, MSI_DESC_ALL) {
1740 if (desc == failed_desc)
1742 devm_free_irq(hba->dev, desc->irq, hba);
1744 msi_unlock_descs(hba->dev);
1745 platform_msi_domain_free_irqs(hba->dev);
1747 if (host->hw_ver.major == 6 && host->hw_ver.minor == 0 &&
1748 host->hw_ver.step == 0)
1749 ufshcd_rmwl(hba, ESI_VEC_MASK,
1750 FIELD_PREP(ESI_VEC_MASK, MAX_ESI_VEC - 1),
1752 ufshcd_mcq_enable_esi(hba);
1757 host->esi_enabled = true;
1763 * struct ufs_hba_qcom_vops - UFS QCOM specific variant operations
1765 * The variant operations configure the necessary controller and PHY
1766 * handshake during initialization.
1768 static const struct ufs_hba_variant_ops ufs_hba_qcom_vops = {
1770 .init = ufs_qcom_init,
1771 .exit = ufs_qcom_exit,
1772 .get_ufs_hci_version = ufs_qcom_get_ufs_hci_version,
1773 .clk_scale_notify = ufs_qcom_clk_scale_notify,
1774 .setup_clocks = ufs_qcom_setup_clocks,
1775 .hce_enable_notify = ufs_qcom_hce_enable_notify,
1776 .link_startup_notify = ufs_qcom_link_startup_notify,
1777 .pwr_change_notify = ufs_qcom_pwr_change_notify,
1778 .apply_dev_quirks = ufs_qcom_apply_dev_quirks,
1779 .suspend = ufs_qcom_suspend,
1780 .resume = ufs_qcom_resume,
1781 .dbg_register_dump = ufs_qcom_dump_dbg_regs,
1782 .device_reset = ufs_qcom_device_reset,
1783 .config_scaling_param = ufs_qcom_config_scaling_param,
1784 .program_key = ufs_qcom_ice_program_key,
1785 .reinit_notify = ufs_qcom_reinit_notify,
1786 .mcq_config_resource = ufs_qcom_mcq_config_resource,
1787 .get_hba_mac = ufs_qcom_get_hba_mac,
1788 .op_runtime_config = ufs_qcom_op_runtime_config,
1789 .get_outstanding_cqs = ufs_qcom_get_outstanding_cqs,
1790 .config_esi = ufs_qcom_config_esi,
1794 * ufs_qcom_probe - probe routine of the driver
1795 * @pdev: pointer to Platform device handle
1797 * Return: zero for success and non-zero for failure.
1799 static int ufs_qcom_probe(struct platform_device *pdev)
1802 struct device *dev = &pdev->dev;
1804 /* Perform generic probe */
1805 err = ufshcd_pltfrm_init(pdev, &ufs_hba_qcom_vops);
1807 return dev_err_probe(dev, err, "ufshcd_pltfrm_init() failed\n");
1813 * ufs_qcom_remove - set driver_data of the device to NULL
1814 * @pdev: pointer to platform device handle
1818 static void ufs_qcom_remove(struct platform_device *pdev)
1820 struct ufs_hba *hba = platform_get_drvdata(pdev);
1822 pm_runtime_get_sync(&(pdev)->dev);
1824 platform_msi_domain_free_irqs(hba->dev);
1827 static const struct of_device_id ufs_qcom_of_match[] __maybe_unused = {
1828 { .compatible = "qcom,ufshc"},
1831 MODULE_DEVICE_TABLE(of, ufs_qcom_of_match);
1834 static const struct acpi_device_id ufs_qcom_acpi_match[] = {
1838 MODULE_DEVICE_TABLE(acpi, ufs_qcom_acpi_match);
1841 static const struct dev_pm_ops ufs_qcom_pm_ops = {
1842 SET_RUNTIME_PM_OPS(ufshcd_runtime_suspend, ufshcd_runtime_resume, NULL)
1843 .prepare = ufshcd_suspend_prepare,
1844 .complete = ufshcd_resume_complete,
1845 #ifdef CONFIG_PM_SLEEP
1846 .suspend = ufshcd_system_suspend,
1847 .resume = ufshcd_system_resume,
1848 .freeze = ufshcd_system_freeze,
1849 .restore = ufshcd_system_restore,
1850 .thaw = ufshcd_system_thaw,
1854 static struct platform_driver ufs_qcom_pltform = {
1855 .probe = ufs_qcom_probe,
1856 .remove_new = ufs_qcom_remove,
1858 .name = "ufshcd-qcom",
1859 .pm = &ufs_qcom_pm_ops,
1860 .of_match_table = of_match_ptr(ufs_qcom_of_match),
1861 .acpi_match_table = ACPI_PTR(ufs_qcom_acpi_match),
1864 module_platform_driver(ufs_qcom_pltform);
1866 MODULE_LICENSE("GPL v2");