1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2013-2016, Linux Foundation. All rights reserved.
6 #include <linux/acpi.h>
7 #include <linux/time.h>
9 #include <linux/delay.h>
10 #include <linux/module.h>
12 #include <linux/platform_device.h>
13 #include <linux/phy/phy.h>
14 #include <linux/gpio/consumer.h>
15 #include <linux/reset-controller.h>
16 #include <linux/devfreq.h>
18 #include <soc/qcom/ice.h>
20 #include <ufs/ufshcd.h>
21 #include "ufshcd-pltfrm.h"
22 #include <ufs/unipro.h>
24 #include <ufs/ufshci.h>
25 #include <ufs/ufs_quirks.h>
27 #define MCQ_QCFGPTR_MASK GENMASK(7, 0)
28 #define MCQ_QCFGPTR_UNIT 0x200
29 #define MCQ_SQATTR_OFFSET(c) \
30 ((((c) >> 16) & MCQ_QCFGPTR_MASK) * MCQ_QCFGPTR_UNIT)
31 #define MCQ_QCFG_SIZE 0x40
49 static struct ufs_qcom_host *ufs_qcom_hosts[MAX_UFS_QCOM_HOSTS];
51 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host);
52 static int ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(struct ufs_hba *hba,
55 static struct ufs_qcom_host *rcdev_to_ufs_host(struct reset_controller_dev *rcd)
57 return container_of(rcd, struct ufs_qcom_host, rcdev);
60 #ifdef CONFIG_SCSI_UFS_CRYPTO
62 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host *host)
64 if (host->hba->caps & UFSHCD_CAP_CRYPTO)
65 qcom_ice_enable(host->ice);
68 static int ufs_qcom_ice_init(struct ufs_qcom_host *host)
70 struct ufs_hba *hba = host->hba;
71 struct device *dev = hba->dev;
74 ice = of_qcom_ice_get(dev);
75 if (ice == ERR_PTR(-EOPNOTSUPP)) {
76 dev_warn(dev, "Disabling inline encryption support\n");
80 if (IS_ERR_OR_NULL(ice))
81 return PTR_ERR_OR_ZERO(ice);
84 hba->caps |= UFSHCD_CAP_CRYPTO;
89 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host *host)
91 if (host->hba->caps & UFSHCD_CAP_CRYPTO)
92 return qcom_ice_resume(host->ice);
97 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host *host)
99 if (host->hba->caps & UFSHCD_CAP_CRYPTO)
100 return qcom_ice_suspend(host->ice);
105 static int ufs_qcom_ice_program_key(struct ufs_hba *hba,
106 const union ufs_crypto_cfg_entry *cfg,
109 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
110 union ufs_crypto_cap_entry cap;
112 cfg->config_enable & UFS_CRYPTO_CONFIGURATION_ENABLE;
114 /* Only AES-256-XTS has been tested so far. */
115 cap = hba->crypto_cap_array[cfg->crypto_cap_idx];
116 if (cap.algorithm_id != UFS_CRYPTO_ALG_AES_XTS ||
117 cap.key_size != UFS_CRYPTO_KEY_SIZE_256)
121 return qcom_ice_program_key(host->ice,
122 QCOM_ICE_CRYPTO_ALG_AES_XTS,
123 QCOM_ICE_CRYPTO_KEY_SIZE_256,
125 cfg->data_unit_size, slot);
127 return qcom_ice_evict_key(host->ice, slot);
132 #define ufs_qcom_ice_program_key NULL
134 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host *host)
138 static int ufs_qcom_ice_init(struct ufs_qcom_host *host)
143 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host *host)
148 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host *host)
154 static int ufs_qcom_host_clk_get(struct device *dev,
155 const char *name, struct clk **clk_out, bool optional)
160 clk = devm_clk_get(dev, name);
168 if (optional && err == -ENOENT) {
173 if (err != -EPROBE_DEFER)
174 dev_err(dev, "failed to get %s err %d\n", name, err);
179 static int ufs_qcom_host_clk_enable(struct device *dev,
180 const char *name, struct clk *clk)
184 err = clk_prepare_enable(clk);
186 dev_err(dev, "%s: %s enable failed %d\n", __func__, name, err);
191 static void ufs_qcom_disable_lane_clks(struct ufs_qcom_host *host)
193 if (!host->is_lane_clks_enabled)
196 clk_disable_unprepare(host->tx_l1_sync_clk);
197 clk_disable_unprepare(host->tx_l0_sync_clk);
198 clk_disable_unprepare(host->rx_l1_sync_clk);
199 clk_disable_unprepare(host->rx_l0_sync_clk);
201 host->is_lane_clks_enabled = false;
204 static int ufs_qcom_enable_lane_clks(struct ufs_qcom_host *host)
207 struct device *dev = host->hba->dev;
209 if (host->is_lane_clks_enabled)
212 err = ufs_qcom_host_clk_enable(dev, "rx_lane0_sync_clk",
213 host->rx_l0_sync_clk);
217 err = ufs_qcom_host_clk_enable(dev, "tx_lane0_sync_clk",
218 host->tx_l0_sync_clk);
222 err = ufs_qcom_host_clk_enable(dev, "rx_lane1_sync_clk",
223 host->rx_l1_sync_clk);
227 err = ufs_qcom_host_clk_enable(dev, "tx_lane1_sync_clk",
228 host->tx_l1_sync_clk);
232 host->is_lane_clks_enabled = true;
237 clk_disable_unprepare(host->rx_l1_sync_clk);
239 clk_disable_unprepare(host->tx_l0_sync_clk);
241 clk_disable_unprepare(host->rx_l0_sync_clk);
246 static int ufs_qcom_init_lane_clks(struct ufs_qcom_host *host)
249 struct device *dev = host->hba->dev;
251 if (has_acpi_companion(dev))
254 err = ufs_qcom_host_clk_get(dev, "rx_lane0_sync_clk",
255 &host->rx_l0_sync_clk, false);
259 err = ufs_qcom_host_clk_get(dev, "tx_lane0_sync_clk",
260 &host->tx_l0_sync_clk, false);
264 /* In case of single lane per direction, don't read lane1 clocks */
265 if (host->hba->lanes_per_direction > 1) {
266 err = ufs_qcom_host_clk_get(dev, "rx_lane1_sync_clk",
267 &host->rx_l1_sync_clk, false);
271 err = ufs_qcom_host_clk_get(dev, "tx_lane1_sync_clk",
272 &host->tx_l1_sync_clk, true);
278 static int ufs_qcom_check_hibern8(struct ufs_hba *hba)
282 unsigned long timeout = jiffies + msecs_to_jiffies(HBRN8_POLL_TOUT_MS);
285 err = ufshcd_dme_get(hba,
286 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
287 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
289 if (err || tx_fsm_val == TX_FSM_HIBERN8)
292 /* sleep for max. 200us */
293 usleep_range(100, 200);
294 } while (time_before(jiffies, timeout));
297 * we might have scheduled out for long during polling so
298 * check the state again.
300 if (time_after(jiffies, timeout))
301 err = ufshcd_dme_get(hba,
302 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
303 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
307 dev_err(hba->dev, "%s: unable to get TX_FSM_STATE, err %d\n",
309 } else if (tx_fsm_val != TX_FSM_HIBERN8) {
311 dev_err(hba->dev, "%s: invalid TX_FSM_STATE = %d\n",
318 static void ufs_qcom_select_unipro_mode(struct ufs_qcom_host *host)
320 ufshcd_rmwl(host->hba, QUNIPRO_SEL,
321 ufs_qcom_cap_qunipro(host) ? QUNIPRO_SEL : 0,
324 if (host->hw_ver.major == 0x05)
325 ufshcd_rmwl(host->hba, QUNIPRO_G4_SEL, 0, REG_UFS_CFG0);
327 /* make sure above configuration is applied before we return */
332 * ufs_qcom_host_reset - reset host controller and PHY
334 static int ufs_qcom_host_reset(struct ufs_hba *hba)
337 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
338 bool reenable_intr = false;
340 if (!host->core_reset) {
341 dev_warn(hba->dev, "%s: reset control not set\n", __func__);
345 reenable_intr = hba->is_irq_enabled;
346 disable_irq(hba->irq);
347 hba->is_irq_enabled = false;
349 ret = reset_control_assert(host->core_reset);
351 dev_err(hba->dev, "%s: core_reset assert failed, err = %d\n",
357 * The hardware requirement for delay between assert/deassert
358 * is at least 3-4 sleep clock (32.7KHz) cycles, which comes to
359 * ~125us (4/32768). To be on the safe side add 200us delay.
361 usleep_range(200, 210);
363 ret = reset_control_deassert(host->core_reset);
365 dev_err(hba->dev, "%s: core_reset deassert failed, err = %d\n",
368 usleep_range(1000, 1100);
371 enable_irq(hba->irq);
372 hba->is_irq_enabled = true;
378 static u32 ufs_qcom_get_hs_gear(struct ufs_hba *hba)
380 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
382 if (host->hw_ver.major == 0x1) {
384 * HS-G3 operations may not reliably work on legacy QCOM
385 * UFS host controller hardware even though capability
386 * exchange during link startup phase may end up
387 * negotiating maximum supported gear as G3.
388 * Hence downgrade the maximum supported gear to HS-G2.
391 } else if (host->hw_ver.major >= 0x4) {
392 return UFS_QCOM_MAX_GEAR(ufshcd_readl(hba, REG_UFS_PARAM0));
395 /* Default is HS-G3 */
399 static int ufs_qcom_power_up_sequence(struct ufs_hba *hba)
401 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
402 struct phy *phy = host->generic_phy;
405 /* Reset UFS Host Controller and PHY */
406 ret = ufs_qcom_host_reset(hba);
408 dev_warn(hba->dev, "%s: host reset returned %d\n",
411 /* phy initialization - calibrate the phy */
414 dev_err(hba->dev, "%s: phy init failed, ret = %d\n",
419 phy_set_mode_ext(phy, PHY_MODE_UFS_HS_B, host->hs_gear);
421 /* power on phy - start serdes and phy's power and clocks */
422 ret = phy_power_on(phy);
424 dev_err(hba->dev, "%s: phy power on failed, ret = %d\n",
426 goto out_disable_phy;
429 ufs_qcom_select_unipro_mode(host);
440 * The UTP controller has a number of internal clock gating cells (CGCs).
441 * Internal hardware sub-modules within the UTP controller control the CGCs.
442 * Hardware CGCs disable the clock to inactivate UTP sub-modules not involved
443 * in a specific operation, UTP controller CGCs are by default disabled and
444 * this function enables them (after every UFS link startup) to save some power
447 static void ufs_qcom_enable_hw_clk_gating(struct ufs_hba *hba)
450 ufshcd_readl(hba, REG_UFS_CFG2) | REG_UFS_CFG2_CGC_EN_ALL,
453 /* Ensure that HW clock gating is enabled before next operations */
457 static int ufs_qcom_hce_enable_notify(struct ufs_hba *hba,
458 enum ufs_notify_change_status status)
460 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
465 ufs_qcom_power_up_sequence(hba);
467 * The PHY PLL output is the source of tx/rx lane symbol
468 * clocks, hence, enable the lane clocks only after PHY
471 err = ufs_qcom_enable_lane_clks(host);
474 /* check if UFS PHY moved from DISABLED to HIBERN8 */
475 err = ufs_qcom_check_hibern8(hba);
476 ufs_qcom_enable_hw_clk_gating(hba);
477 ufs_qcom_ice_enable(host);
480 dev_err(hba->dev, "%s: invalid status %d\n", __func__, status);
488 * Return: zero for success and non-zero in case of a failure.
490 static int ufs_qcom_cfg_timers(struct ufs_hba *hba, u32 gear,
491 u32 hs, u32 rate, bool update_link_startup_timer)
493 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
494 struct ufs_clk_info *clki;
495 u32 core_clk_period_in_ns;
496 u32 tx_clk_cycles_per_us = 0;
497 unsigned long core_clk_rate = 0;
498 u32 core_clk_cycles_per_us = 0;
500 static u32 pwm_fr_table[][2] = {
507 static u32 hs_fr_table_rA[][2] = {
513 static u32 hs_fr_table_rB[][2] = {
520 * The Qunipro controller does not use following registers:
521 * SYS1CLK_1US_REG, TX_SYMBOL_CLK_1US_REG, CLK_NS_REG &
522 * UFS_REG_PA_LINK_STARTUP_TIMER
523 * But UTP controller uses SYS1CLK_1US_REG register for Interrupt
526 if (ufs_qcom_cap_qunipro(host) && !ufshcd_is_intr_aggr_allowed(hba))
530 dev_err(hba->dev, "%s: invalid gear = %d\n", __func__, gear);
534 list_for_each_entry(clki, &hba->clk_list_head, list) {
535 if (!strcmp(clki->name, "core_clk"))
536 core_clk_rate = clk_get_rate(clki->clk);
539 /* If frequency is smaller than 1MHz, set to 1MHz */
540 if (core_clk_rate < DEFAULT_CLK_RATE_HZ)
541 core_clk_rate = DEFAULT_CLK_RATE_HZ;
543 core_clk_cycles_per_us = core_clk_rate / USEC_PER_SEC;
544 if (ufshcd_readl(hba, REG_UFS_SYS1CLK_1US) != core_clk_cycles_per_us) {
545 ufshcd_writel(hba, core_clk_cycles_per_us, REG_UFS_SYS1CLK_1US);
547 * make sure above write gets applied before we return from
553 if (ufs_qcom_cap_qunipro(host))
556 core_clk_period_in_ns = NSEC_PER_SEC / core_clk_rate;
557 core_clk_period_in_ns <<= OFFSET_CLK_NS_REG;
558 core_clk_period_in_ns &= MASK_CLK_NS_REG;
563 if (rate == PA_HS_MODE_A) {
564 if (gear > ARRAY_SIZE(hs_fr_table_rA)) {
566 "%s: index %d exceeds table size %zu\n",
568 ARRAY_SIZE(hs_fr_table_rA));
571 tx_clk_cycles_per_us = hs_fr_table_rA[gear-1][1];
572 } else if (rate == PA_HS_MODE_B) {
573 if (gear > ARRAY_SIZE(hs_fr_table_rB)) {
575 "%s: index %d exceeds table size %zu\n",
577 ARRAY_SIZE(hs_fr_table_rB));
580 tx_clk_cycles_per_us = hs_fr_table_rB[gear-1][1];
582 dev_err(hba->dev, "%s: invalid rate = %d\n",
589 if (gear > ARRAY_SIZE(pwm_fr_table)) {
591 "%s: index %d exceeds table size %zu\n",
593 ARRAY_SIZE(pwm_fr_table));
596 tx_clk_cycles_per_us = pwm_fr_table[gear-1][1];
600 dev_err(hba->dev, "%s: invalid mode = %d\n", __func__, hs);
604 if (ufshcd_readl(hba, REG_UFS_TX_SYMBOL_CLK_NS_US) !=
605 (core_clk_period_in_ns | tx_clk_cycles_per_us)) {
606 /* this register 2 fields shall be written at once */
607 ufshcd_writel(hba, core_clk_period_in_ns | tx_clk_cycles_per_us,
608 REG_UFS_TX_SYMBOL_CLK_NS_US);
610 * make sure above write gets applied before we return from
616 if (update_link_startup_timer && host->hw_ver.major != 0x5) {
617 ufshcd_writel(hba, ((core_clk_rate / MSEC_PER_SEC) * 100),
620 * make sure that this configuration is applied before
629 static int ufs_qcom_link_startup_notify(struct ufs_hba *hba,
630 enum ufs_notify_change_status status)
633 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
637 if (ufs_qcom_cfg_timers(hba, UFS_PWM_G1, SLOWAUTO_MODE,
639 dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
644 if (ufs_qcom_cap_qunipro(host))
646 * set unipro core clock cycles to 150 & clear clock
649 err = ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba,
653 * Some UFS devices (and may be host) have issues if LCC is
654 * enabled. So we are setting PA_Local_TX_LCC_Enable to 0
655 * before link startup which will make sure that both host
656 * and device TX LCC are disabled once link startup is
659 if (ufshcd_get_local_unipro_ver(hba) != UFS_UNIPRO_VER_1_41)
660 err = ufshcd_disable_host_tx_lcc(hba);
670 static void ufs_qcom_device_reset_ctrl(struct ufs_hba *hba, bool asserted)
672 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
674 /* reset gpio is optional */
675 if (!host->device_reset)
678 gpiod_set_value_cansleep(host->device_reset, asserted);
681 static int ufs_qcom_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op,
682 enum ufs_notify_change_status status)
684 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
685 struct phy *phy = host->generic_phy;
687 if (status == PRE_CHANGE)
690 if (ufs_qcom_is_link_off(hba)) {
692 * Disable the tx/rx lane symbol clocks before PHY is
693 * powered down as the PLL source should be disabled
694 * after downstream clocks are disabled.
696 ufs_qcom_disable_lane_clks(host);
699 /* reset the connected UFS device during power down */
700 ufs_qcom_device_reset_ctrl(hba, true);
702 } else if (!ufs_qcom_is_link_active(hba)) {
703 ufs_qcom_disable_lane_clks(host);
706 return ufs_qcom_ice_suspend(host);
709 static int ufs_qcom_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
711 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
712 struct phy *phy = host->generic_phy;
715 if (ufs_qcom_is_link_off(hba)) {
716 err = phy_power_on(phy);
718 dev_err(hba->dev, "%s: failed PHY power on: %d\n",
723 err = ufs_qcom_enable_lane_clks(host);
727 } else if (!ufs_qcom_is_link_active(hba)) {
728 err = ufs_qcom_enable_lane_clks(host);
733 return ufs_qcom_ice_resume(host);
736 static void ufs_qcom_dev_ref_clk_ctrl(struct ufs_qcom_host *host, bool enable)
738 if (host->dev_ref_clk_ctrl_mmio &&
739 (enable ^ host->is_dev_ref_clk_enabled)) {
740 u32 temp = readl_relaxed(host->dev_ref_clk_ctrl_mmio);
743 temp |= host->dev_ref_clk_en_mask;
745 temp &= ~host->dev_ref_clk_en_mask;
748 * If we are here to disable this clock it might be immediately
749 * after entering into hibern8 in which case we need to make
750 * sure that device ref_clk is active for specific time after
754 unsigned long gating_wait;
756 gating_wait = host->hba->dev_info.clk_gating_wait_us;
761 * bRefClkGatingWaitTime defines the minimum
762 * time for which the reference clock is
763 * required by device during transition from
764 * HS-MODE to LS-MODE or HIBERN8 state. Give it
765 * more delay to be on the safe side.
768 usleep_range(gating_wait, gating_wait + 10);
772 writel_relaxed(temp, host->dev_ref_clk_ctrl_mmio);
775 * Make sure the write to ref_clk reaches the destination and
776 * not stored in a Write Buffer (WB).
778 readl(host->dev_ref_clk_ctrl_mmio);
781 * If we call hibern8 exit after this, we need to make sure that
782 * device ref_clk is stable for at least 1us before the hibern8
788 host->is_dev_ref_clk_enabled = enable;
792 static int ufs_qcom_pwr_change_notify(struct ufs_hba *hba,
793 enum ufs_notify_change_status status,
794 struct ufs_pa_layer_attr *dev_max_params,
795 struct ufs_pa_layer_attr *dev_req_params)
797 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
798 struct ufs_dev_params ufs_qcom_cap;
801 if (!dev_req_params) {
802 pr_err("%s: incoming dev_req_params is NULL\n", __func__);
808 ufshcd_init_pwr_dev_param(&ufs_qcom_cap);
809 ufs_qcom_cap.hs_rate = UFS_QCOM_LIMIT_HS_RATE;
811 /* This driver only supports symmetic gear setting i.e., hs_tx_gear == hs_rx_gear */
812 ufs_qcom_cap.hs_tx_gear = ufs_qcom_cap.hs_rx_gear = ufs_qcom_get_hs_gear(hba);
814 ret = ufshcd_get_pwr_dev_param(&ufs_qcom_cap,
818 dev_err(hba->dev, "%s: failed to determine capabilities\n",
823 /* Use the agreed gear */
824 host->hs_gear = dev_req_params->gear_tx;
826 /* enable the device ref clock before changing to HS mode */
827 if (!ufshcd_is_hs_mode(&hba->pwr_info) &&
828 ufshcd_is_hs_mode(dev_req_params))
829 ufs_qcom_dev_ref_clk_ctrl(host, true);
831 if (host->hw_ver.major >= 0x4) {
832 ufshcd_dme_configure_adapt(hba,
833 dev_req_params->gear_tx,
838 if (ufs_qcom_cfg_timers(hba, dev_req_params->gear_rx,
839 dev_req_params->pwr_rx,
840 dev_req_params->hs_rate, false)) {
841 dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
844 * we return error code at the end of the routine,
845 * but continue to configure UFS_PHY_TX_LANE_ENABLE
846 * and bus voting as usual
851 /* cache the power mode parameters to use internally */
852 memcpy(&host->dev_req_params,
853 dev_req_params, sizeof(*dev_req_params));
855 /* disable the device ref clock if entered PWM mode */
856 if (ufshcd_is_hs_mode(&hba->pwr_info) &&
857 !ufshcd_is_hs_mode(dev_req_params))
858 ufs_qcom_dev_ref_clk_ctrl(host, false);
868 static int ufs_qcom_quirk_host_pa_saveconfigtime(struct ufs_hba *hba)
871 u32 pa_vs_config_reg1;
873 err = ufshcd_dme_get(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
878 /* Allow extension of MSB bits of PA_SaveConfigTime attribute */
879 return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
880 (pa_vs_config_reg1 | (1 << 12)));
883 static int ufs_qcom_apply_dev_quirks(struct ufs_hba *hba)
887 if (hba->dev_quirks & UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME)
888 err = ufs_qcom_quirk_host_pa_saveconfigtime(hba);
890 if (hba->dev_info.wmanufacturerid == UFS_VENDOR_WDC)
891 hba->dev_quirks |= UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE;
896 static u32 ufs_qcom_get_ufs_hci_version(struct ufs_hba *hba)
898 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
900 if (host->hw_ver.major == 0x1)
901 return ufshci_version(1, 1);
903 return ufshci_version(2, 0);
907 * ufs_qcom_advertise_quirks - advertise the known QCOM UFS controller quirks
908 * @hba: host controller instance
910 * QCOM UFS host controller might have some non standard behaviours (quirks)
911 * than what is specified by UFSHCI specification. Advertise all such
912 * quirks to standard UFS host controller driver so standard takes them into
915 static void ufs_qcom_advertise_quirks(struct ufs_hba *hba)
917 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
919 if (host->hw_ver.major == 0x01) {
920 hba->quirks |= UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
921 | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP
922 | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE;
924 if (host->hw_ver.minor == 0x0001 && host->hw_ver.step == 0x0001)
925 hba->quirks |= UFSHCD_QUIRK_BROKEN_INTR_AGGR;
927 hba->quirks |= UFSHCD_QUIRK_BROKEN_LCC;
930 if (host->hw_ver.major == 0x2) {
931 hba->quirks |= UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION;
933 if (!ufs_qcom_cap_qunipro(host))
934 /* Legacy UniPro mode still need following quirks */
935 hba->quirks |= (UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
936 | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE
937 | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP);
940 if (host->hw_ver.major > 0x3)
941 hba->quirks |= UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH;
944 static void ufs_qcom_set_caps(struct ufs_hba *hba)
946 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
948 hba->caps |= UFSHCD_CAP_CLK_GATING | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
949 hba->caps |= UFSHCD_CAP_CLK_SCALING | UFSHCD_CAP_WB_WITH_CLK_SCALING;
950 hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
951 hba->caps |= UFSHCD_CAP_WB_EN;
952 hba->caps |= UFSHCD_CAP_AGGR_POWER_COLLAPSE;
953 hba->caps |= UFSHCD_CAP_RPM_AUTOSUSPEND;
955 if (host->hw_ver.major >= 0x2) {
956 host->caps = UFS_QCOM_CAP_QUNIPRO |
957 UFS_QCOM_CAP_RETAIN_SEC_CFG_AFTER_PWR_COLLAPSE;
962 * ufs_qcom_setup_clocks - enables/disable clocks
963 * @hba: host controller instance
964 * @on: If true, enable clocks else disable them.
965 * @status: PRE_CHANGE or POST_CHANGE notify
967 * Return: 0 on success, non-zero on failure.
969 static int ufs_qcom_setup_clocks(struct ufs_hba *hba, bool on,
970 enum ufs_notify_change_status status)
972 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
975 * In case ufs_qcom_init() is not yet done, simply ignore.
976 * This ufs_qcom_setup_clocks() shall be called from
977 * ufs_qcom_init() after init is done.
985 if (!ufs_qcom_is_link_active(hba)) {
986 /* disable device ref_clk */
987 ufs_qcom_dev_ref_clk_ctrl(host, false);
993 /* enable the device ref clock for HS mode*/
994 if (ufshcd_is_hs_mode(&hba->pwr_info))
995 ufs_qcom_dev_ref_clk_ctrl(host, true);
1004 ufs_qcom_reset_assert(struct reset_controller_dev *rcdev, unsigned long id)
1006 struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
1008 ufs_qcom_assert_reset(host->hba);
1009 /* provide 1ms delay to let the reset pulse propagate. */
1010 usleep_range(1000, 1100);
1015 ufs_qcom_reset_deassert(struct reset_controller_dev *rcdev, unsigned long id)
1017 struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
1019 ufs_qcom_deassert_reset(host->hba);
1022 * after reset deassertion, phy will need all ref clocks,
1023 * voltage, current to settle down before starting serdes.
1025 usleep_range(1000, 1100);
1029 static const struct reset_control_ops ufs_qcom_reset_ops = {
1030 .assert = ufs_qcom_reset_assert,
1031 .deassert = ufs_qcom_reset_deassert,
1035 * ufs_qcom_init - bind phy with controller
1036 * @hba: host controller instance
1038 * Binds PHY with controller and powers up PHY enabling clocks
1041 * Return: -EPROBE_DEFER if binding fails, returns negative error
1042 * on phy power up failure and returns zero on success.
1044 static int ufs_qcom_init(struct ufs_hba *hba)
1047 struct device *dev = hba->dev;
1048 struct platform_device *pdev = to_platform_device(dev);
1049 struct ufs_qcom_host *host;
1050 struct resource *res;
1051 struct ufs_clk_info *clki;
1053 host = devm_kzalloc(dev, sizeof(*host), GFP_KERNEL);
1055 dev_err(dev, "%s: no memory for qcom ufs host\n", __func__);
1059 /* Make a two way bind between the qcom host and the hba */
1061 ufshcd_set_variant(hba, host);
1063 /* Setup the optional reset control of HCI */
1064 host->core_reset = devm_reset_control_get_optional(hba->dev, "rst");
1065 if (IS_ERR(host->core_reset)) {
1066 err = dev_err_probe(dev, PTR_ERR(host->core_reset),
1067 "Failed to get reset control\n");
1068 goto out_variant_clear;
1071 /* Fire up the reset controller. Failure here is non-fatal. */
1072 host->rcdev.of_node = dev->of_node;
1073 host->rcdev.ops = &ufs_qcom_reset_ops;
1074 host->rcdev.owner = dev->driver->owner;
1075 host->rcdev.nr_resets = 1;
1076 err = devm_reset_controller_register(dev, &host->rcdev);
1078 dev_warn(dev, "Failed to register reset controller\n");
1080 if (!has_acpi_companion(dev)) {
1081 host->generic_phy = devm_phy_get(dev, "ufsphy");
1082 if (IS_ERR(host->generic_phy)) {
1083 err = dev_err_probe(dev, PTR_ERR(host->generic_phy), "Failed to get PHY\n");
1084 goto out_variant_clear;
1088 host->device_reset = devm_gpiod_get_optional(dev, "reset",
1090 if (IS_ERR(host->device_reset)) {
1091 err = PTR_ERR(host->device_reset);
1092 if (err != -EPROBE_DEFER)
1093 dev_err(dev, "failed to acquire reset gpio: %d\n", err);
1094 goto out_variant_clear;
1097 ufs_qcom_get_controller_revision(hba, &host->hw_ver.major,
1098 &host->hw_ver.minor, &host->hw_ver.step);
1101 * for newer controllers, device reference clock control bit has
1102 * moved inside UFS controller register address space itself.
1104 if (host->hw_ver.major >= 0x02) {
1105 host->dev_ref_clk_ctrl_mmio = hba->mmio_base + REG_UFS_CFG1;
1106 host->dev_ref_clk_en_mask = BIT(26);
1108 /* "dev_ref_clk_ctrl_mem" is optional resource */
1109 res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
1110 "dev_ref_clk_ctrl_mem");
1112 host->dev_ref_clk_ctrl_mmio =
1113 devm_ioremap_resource(dev, res);
1114 if (IS_ERR(host->dev_ref_clk_ctrl_mmio))
1115 host->dev_ref_clk_ctrl_mmio = NULL;
1116 host->dev_ref_clk_en_mask = BIT(5);
1120 list_for_each_entry(clki, &hba->clk_list_head, list) {
1121 if (!strcmp(clki->name, "core_clk_unipro"))
1122 clki->keep_link_active = true;
1125 err = ufs_qcom_init_lane_clks(host);
1127 goto out_variant_clear;
1129 ufs_qcom_set_caps(hba);
1130 ufs_qcom_advertise_quirks(hba);
1132 err = ufs_qcom_ice_init(host);
1134 goto out_variant_clear;
1136 ufs_qcom_setup_clocks(hba, true, POST_CHANGE);
1138 if (hba->dev->id < MAX_UFS_QCOM_HOSTS)
1139 ufs_qcom_hosts[hba->dev->id] = host;
1141 ufs_qcom_get_default_testbus_cfg(host);
1142 err = ufs_qcom_testbus_config(host);
1144 /* Failure is non-fatal */
1145 dev_warn(dev, "%s: failed to configure the testbus %d\n",
1149 * Power up the PHY using the minimum supported gear (UFS_HS_G2).
1150 * Switching to max gear will be performed during reinit if supported.
1152 host->hs_gear = UFS_HS_G2;
1157 ufshcd_set_variant(hba, NULL);
1162 static void ufs_qcom_exit(struct ufs_hba *hba)
1164 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1166 ufs_qcom_disable_lane_clks(host);
1167 phy_power_off(host->generic_phy);
1168 phy_exit(host->generic_phy);
1171 static int ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(struct ufs_hba *hba,
1175 u32 core_clk_ctrl_reg;
1177 if (clk_cycles > DME_VS_CORE_CLK_CTRL_MAX_CORE_CLK_1US_CYCLES_MASK)
1180 err = ufshcd_dme_get(hba,
1181 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1182 &core_clk_ctrl_reg);
1186 core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_MAX_CORE_CLK_1US_CYCLES_MASK;
1187 core_clk_ctrl_reg |= clk_cycles;
1189 /* Clear CORE_CLK_DIV_EN */
1190 core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1192 return ufshcd_dme_set(hba,
1193 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1197 static int ufs_qcom_clk_scale_up_pre_change(struct ufs_hba *hba)
1199 /* nothing to do as of now */
1203 static int ufs_qcom_clk_scale_up_post_change(struct ufs_hba *hba)
1205 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1207 if (!ufs_qcom_cap_qunipro(host))
1210 /* set unipro core clock cycles to 150 and clear clock divider */
1211 return ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba, 150);
1214 static int ufs_qcom_clk_scale_down_pre_change(struct ufs_hba *hba)
1216 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1218 u32 core_clk_ctrl_reg;
1220 if (!ufs_qcom_cap_qunipro(host))
1223 err = ufshcd_dme_get(hba,
1224 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1225 &core_clk_ctrl_reg);
1227 /* make sure CORE_CLK_DIV_EN is cleared */
1229 (core_clk_ctrl_reg & DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT)) {
1230 core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1231 err = ufshcd_dme_set(hba,
1232 UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1239 static int ufs_qcom_clk_scale_down_post_change(struct ufs_hba *hba)
1241 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1243 if (!ufs_qcom_cap_qunipro(host))
1246 /* set unipro core clock cycles to 75 and clear clock divider */
1247 return ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba, 75);
1250 static int ufs_qcom_clk_scale_notify(struct ufs_hba *hba,
1251 bool scale_up, enum ufs_notify_change_status status)
1253 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1254 struct ufs_pa_layer_attr *dev_req_params = &host->dev_req_params;
1257 if (status == PRE_CHANGE) {
1258 err = ufshcd_uic_hibern8_enter(hba);
1262 err = ufs_qcom_clk_scale_up_pre_change(hba);
1264 err = ufs_qcom_clk_scale_down_pre_change(hba);
1266 ufshcd_uic_hibern8_exit(hba);
1270 err = ufs_qcom_clk_scale_up_post_change(hba);
1272 err = ufs_qcom_clk_scale_down_post_change(hba);
1276 ufshcd_uic_hibern8_exit(hba);
1280 ufs_qcom_cfg_timers(hba,
1281 dev_req_params->gear_rx,
1282 dev_req_params->pwr_rx,
1283 dev_req_params->hs_rate,
1285 ufshcd_uic_hibern8_exit(hba);
1291 static void ufs_qcom_enable_test_bus(struct ufs_qcom_host *host)
1293 ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN,
1294 UFS_REG_TEST_BUS_EN, REG_UFS_CFG1);
1295 ufshcd_rmwl(host->hba, TEST_BUS_EN, TEST_BUS_EN, REG_UFS_CFG1);
1298 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host)
1300 /* provide a legal default configuration */
1301 host->testbus.select_major = TSTBUS_UNIPRO;
1302 host->testbus.select_minor = 37;
1305 static bool ufs_qcom_testbus_cfg_is_ok(struct ufs_qcom_host *host)
1307 if (host->testbus.select_major >= TSTBUS_MAX) {
1308 dev_err(host->hba->dev,
1309 "%s: UFS_CFG1[TEST_BUS_SEL} may not equal 0x%05X\n",
1310 __func__, host->testbus.select_major);
1317 int ufs_qcom_testbus_config(struct ufs_qcom_host *host)
1321 u32 mask = TEST_BUS_SUB_SEL_MASK;
1326 if (!ufs_qcom_testbus_cfg_is_ok(host))
1329 switch (host->testbus.select_major) {
1331 reg = UFS_TEST_BUS_CTRL_0;
1335 reg = UFS_TEST_BUS_CTRL_0;
1339 reg = UFS_TEST_BUS_CTRL_0;
1343 reg = UFS_TEST_BUS_CTRL_0;
1347 reg = UFS_TEST_BUS_CTRL_1;
1351 reg = UFS_TEST_BUS_CTRL_1;
1355 reg = UFS_TEST_BUS_CTRL_1;
1359 reg = UFS_TEST_BUS_CTRL_1;
1362 case TSTBUS_WRAPPER:
1363 reg = UFS_TEST_BUS_CTRL_2;
1366 case TSTBUS_COMBINED:
1367 reg = UFS_TEST_BUS_CTRL_2;
1370 case TSTBUS_UTP_HCI:
1371 reg = UFS_TEST_BUS_CTRL_2;
1375 reg = UFS_UNIPRO_CFG;
1380 * No need for a default case, since
1381 * ufs_qcom_testbus_cfg_is_ok() checks that the configuration
1386 ufshcd_rmwl(host->hba, TEST_BUS_SEL,
1387 (u32)host->testbus.select_major << 19,
1389 ufshcd_rmwl(host->hba, mask,
1390 (u32)host->testbus.select_minor << offset,
1392 ufs_qcom_enable_test_bus(host);
1394 * Make sure the test bus configuration is
1395 * committed before returning.
1402 static void ufs_qcom_dump_dbg_regs(struct ufs_hba *hba)
1405 struct ufs_qcom_host *host;
1407 host = ufshcd_get_variant(hba);
1409 ufshcd_dump_regs(hba, REG_UFS_SYS1CLK_1US, 16 * 4,
1410 "HCI Vendor Specific Registers ");
1412 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_REG_OCSC);
1413 ufshcd_dump_regs(hba, reg, 44 * 4, "UFS_UFS_DBG_RD_REG_OCSC ");
1415 reg = ufshcd_readl(hba, REG_UFS_CFG1);
1416 reg |= UTP_DBG_RAMS_EN;
1417 ufshcd_writel(hba, reg, REG_UFS_CFG1);
1419 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_EDTL_RAM);
1420 ufshcd_dump_regs(hba, reg, 32 * 4, "UFS_UFS_DBG_RD_EDTL_RAM ");
1422 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_DESC_RAM);
1423 ufshcd_dump_regs(hba, reg, 128 * 4, "UFS_UFS_DBG_RD_DESC_RAM ");
1425 reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_PRDT_RAM);
1426 ufshcd_dump_regs(hba, reg, 64 * 4, "UFS_UFS_DBG_RD_PRDT_RAM ");
1428 /* clear bit 17 - UTP_DBG_RAMS_EN */
1429 ufshcd_rmwl(hba, UTP_DBG_RAMS_EN, 0, REG_UFS_CFG1);
1431 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UAWM);
1432 ufshcd_dump_regs(hba, reg, 4 * 4, "UFS_DBG_RD_REG_UAWM ");
1434 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UARM);
1435 ufshcd_dump_regs(hba, reg, 4 * 4, "UFS_DBG_RD_REG_UARM ");
1437 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TXUC);
1438 ufshcd_dump_regs(hba, reg, 48 * 4, "UFS_DBG_RD_REG_TXUC ");
1440 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_RXUC);
1441 ufshcd_dump_regs(hba, reg, 27 * 4, "UFS_DBG_RD_REG_RXUC ");
1443 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_DFC);
1444 ufshcd_dump_regs(hba, reg, 19 * 4, "UFS_DBG_RD_REG_DFC ");
1446 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TRLUT);
1447 ufshcd_dump_regs(hba, reg, 34 * 4, "UFS_DBG_RD_REG_TRLUT ");
1449 reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TMRLUT);
1450 ufshcd_dump_regs(hba, reg, 9 * 4, "UFS_DBG_RD_REG_TMRLUT ");
1454 * ufs_qcom_device_reset() - toggle the (optional) device reset line
1455 * @hba: per-adapter instance
1457 * Toggles the (optional) reset line to reset the attached device.
1459 static int ufs_qcom_device_reset(struct ufs_hba *hba)
1461 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1463 /* reset gpio is optional */
1464 if (!host->device_reset)
1468 * The UFS device shall detect reset pulses of 1us, sleep for 10us to
1469 * be on the safe side.
1471 ufs_qcom_device_reset_ctrl(hba, true);
1472 usleep_range(10, 15);
1474 ufs_qcom_device_reset_ctrl(hba, false);
1475 usleep_range(10, 15);
1480 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
1481 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1482 struct devfreq_dev_profile *p,
1483 struct devfreq_simple_ondemand_data *d)
1486 p->timer = DEVFREQ_TIMER_DELAYED;
1487 d->upthreshold = 70;
1488 d->downdifferential = 5;
1491 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1492 struct devfreq_dev_profile *p,
1493 struct devfreq_simple_ondemand_data *data)
1498 static void ufs_qcom_reinit_notify(struct ufs_hba *hba)
1500 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1502 phy_power_off(host->generic_phy);
1506 static const struct ufshcd_res_info ufs_res_info[RES_MAX] = {
1507 {.name = "ufs_mem",},
1509 /* Submission Queue DAO */
1510 {.name = "mcq_sqd",},
1511 /* Submission Queue Interrupt Status */
1512 {.name = "mcq_sqis",},
1513 /* Completion Queue DAO */
1514 {.name = "mcq_cqd",},
1515 /* Completion Queue Interrupt Status */
1516 {.name = "mcq_cqis",},
1517 /* MCQ vendor specific */
1518 {.name = "mcq_vs",},
1521 static int ufs_qcom_mcq_config_resource(struct ufs_hba *hba)
1523 struct platform_device *pdev = to_platform_device(hba->dev);
1524 struct ufshcd_res_info *res;
1525 struct resource *res_mem, *res_mcq;
1528 memcpy(hba->res, ufs_res_info, sizeof(ufs_res_info));
1530 for (i = 0; i < RES_MAX; i++) {
1532 res->resource = platform_get_resource_byname(pdev,
1535 if (!res->resource) {
1536 dev_info(hba->dev, "Resource %s not provided\n", res->name);
1540 } else if (i == RES_UFS) {
1541 res_mem = res->resource;
1542 res->base = hba->mmio_base;
1546 res->base = devm_ioremap_resource(hba->dev, res->resource);
1547 if (IS_ERR(res->base)) {
1548 dev_err(hba->dev, "Failed to map res %s, err=%d\n",
1549 res->name, (int)PTR_ERR(res->base));
1550 ret = PTR_ERR(res->base);
1556 /* MCQ resource provided in DT */
1557 res = &hba->res[RES_MCQ];
1558 /* Bail if MCQ resource is provided */
1562 /* Explicitly allocate MCQ resource from ufs_mem */
1563 res_mcq = devm_kzalloc(hba->dev, sizeof(*res_mcq), GFP_KERNEL);
1567 res_mcq->start = res_mem->start +
1568 MCQ_SQATTR_OFFSET(hba->mcq_capabilities);
1569 res_mcq->end = res_mcq->start + hba->nr_hw_queues * MCQ_QCFG_SIZE - 1;
1570 res_mcq->flags = res_mem->flags;
1571 res_mcq->name = "mcq";
1573 ret = insert_resource(&iomem_resource, res_mcq);
1575 dev_err(hba->dev, "Failed to insert MCQ resource, err=%d\n",
1580 res->base = devm_ioremap_resource(hba->dev, res_mcq);
1581 if (IS_ERR(res->base)) {
1582 dev_err(hba->dev, "MCQ registers mapping failed, err=%d\n",
1583 (int)PTR_ERR(res->base));
1584 ret = PTR_ERR(res->base);
1589 hba->mcq_base = res->base;
1593 remove_resource(res_mcq);
1597 static int ufs_qcom_op_runtime_config(struct ufs_hba *hba)
1599 struct ufshcd_res_info *mem_res, *sqdao_res;
1600 struct ufshcd_mcq_opr_info_t *opr;
1603 mem_res = &hba->res[RES_UFS];
1604 sqdao_res = &hba->res[RES_MCQ_SQD];
1606 if (!mem_res->base || !sqdao_res->base)
1609 for (i = 0; i < OPR_MAX; i++) {
1610 opr = &hba->mcq_opr[i];
1611 opr->offset = sqdao_res->resource->start -
1612 mem_res->resource->start + 0x40 * i;
1613 opr->stride = 0x100;
1614 opr->base = sqdao_res->base + 0x40 * i;
1620 static int ufs_qcom_get_hba_mac(struct ufs_hba *hba)
1622 /* Qualcomm HC supports up to 64 */
1623 return MAX_SUPP_MAC;
1626 static int ufs_qcom_get_outstanding_cqs(struct ufs_hba *hba,
1627 unsigned long *ocqs)
1629 struct ufshcd_res_info *mcq_vs_res = &hba->res[RES_MCQ_VS];
1631 if (!mcq_vs_res->base)
1634 *ocqs = readl(mcq_vs_res->base + UFS_MEM_CQIS_VS);
1639 static void ufs_qcom_write_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1641 struct device *dev = msi_desc_to_dev(desc);
1642 struct ufs_hba *hba = dev_get_drvdata(dev);
1644 ufshcd_mcq_config_esi(hba, msg);
1647 static irqreturn_t ufs_qcom_mcq_esi_handler(int irq, void *data)
1649 struct msi_desc *desc = data;
1650 struct device *dev = msi_desc_to_dev(desc);
1651 struct ufs_hba *hba = dev_get_drvdata(dev);
1652 u32 id = desc->msi_index;
1653 struct ufs_hw_queue *hwq = &hba->uhq[id];
1655 ufshcd_mcq_write_cqis(hba, 0x1, id);
1656 ufshcd_mcq_poll_cqe_lock(hba, hwq);
1661 static int ufs_qcom_config_esi(struct ufs_hba *hba)
1663 struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1664 struct msi_desc *desc;
1665 struct msi_desc *failed_desc = NULL;
1668 if (host->esi_enabled)
1672 * 1. We only handle CQs as of now.
1673 * 2. Poll queues do not need ESI.
1675 nr_irqs = hba->nr_hw_queues - hba->nr_queues[HCTX_TYPE_POLL];
1676 ret = platform_msi_domain_alloc_irqs(hba->dev, nr_irqs,
1677 ufs_qcom_write_msi_msg);
1679 dev_err(hba->dev, "Failed to request Platform MSI %d\n", ret);
1683 msi_lock_descs(hba->dev);
1684 msi_for_each_desc(desc, hba->dev, MSI_DESC_ALL) {
1685 ret = devm_request_irq(hba->dev, desc->irq,
1686 ufs_qcom_mcq_esi_handler,
1687 IRQF_SHARED, "qcom-mcq-esi", desc);
1689 dev_err(hba->dev, "%s: Fail to request IRQ for %d, err = %d\n",
1690 __func__, desc->irq, ret);
1695 msi_unlock_descs(hba->dev);
1699 msi_lock_descs(hba->dev);
1700 msi_for_each_desc(desc, hba->dev, MSI_DESC_ALL) {
1701 if (desc == failed_desc)
1703 devm_free_irq(hba->dev, desc->irq, hba);
1705 msi_unlock_descs(hba->dev);
1706 platform_msi_domain_free_irqs(hba->dev);
1708 if (host->hw_ver.major == 6 && host->hw_ver.minor == 0 &&
1709 host->hw_ver.step == 0) {
1711 ufshcd_readl(hba, REG_UFS_CFG3) | 0x1F000,
1714 ufshcd_mcq_enable_esi(hba);
1719 host->esi_enabled = true;
1725 * struct ufs_hba_qcom_vops - UFS QCOM specific variant operations
1727 * The variant operations configure the necessary controller and PHY
1728 * handshake during initialization.
1730 static const struct ufs_hba_variant_ops ufs_hba_qcom_vops = {
1732 .init = ufs_qcom_init,
1733 .exit = ufs_qcom_exit,
1734 .get_ufs_hci_version = ufs_qcom_get_ufs_hci_version,
1735 .clk_scale_notify = ufs_qcom_clk_scale_notify,
1736 .setup_clocks = ufs_qcom_setup_clocks,
1737 .hce_enable_notify = ufs_qcom_hce_enable_notify,
1738 .link_startup_notify = ufs_qcom_link_startup_notify,
1739 .pwr_change_notify = ufs_qcom_pwr_change_notify,
1740 .apply_dev_quirks = ufs_qcom_apply_dev_quirks,
1741 .suspend = ufs_qcom_suspend,
1742 .resume = ufs_qcom_resume,
1743 .dbg_register_dump = ufs_qcom_dump_dbg_regs,
1744 .device_reset = ufs_qcom_device_reset,
1745 .config_scaling_param = ufs_qcom_config_scaling_param,
1746 .program_key = ufs_qcom_ice_program_key,
1747 .reinit_notify = ufs_qcom_reinit_notify,
1748 .mcq_config_resource = ufs_qcom_mcq_config_resource,
1749 .get_hba_mac = ufs_qcom_get_hba_mac,
1750 .op_runtime_config = ufs_qcom_op_runtime_config,
1751 .get_outstanding_cqs = ufs_qcom_get_outstanding_cqs,
1752 .config_esi = ufs_qcom_config_esi,
1756 * ufs_qcom_probe - probe routine of the driver
1757 * @pdev: pointer to Platform device handle
1759 * Return: zero for success and non-zero for failure.
1761 static int ufs_qcom_probe(struct platform_device *pdev)
1764 struct device *dev = &pdev->dev;
1766 /* Perform generic probe */
1767 err = ufshcd_pltfrm_init(pdev, &ufs_hba_qcom_vops);
1769 return dev_err_probe(dev, err, "ufshcd_pltfrm_init() failed\n");
1775 * ufs_qcom_remove - set driver_data of the device to NULL
1776 * @pdev: pointer to platform device handle
1780 static int ufs_qcom_remove(struct platform_device *pdev)
1782 struct ufs_hba *hba = platform_get_drvdata(pdev);
1784 pm_runtime_get_sync(&(pdev)->dev);
1786 platform_msi_domain_free_irqs(hba->dev);
1790 static const struct of_device_id ufs_qcom_of_match[] __maybe_unused = {
1791 { .compatible = "qcom,ufshc"},
1794 MODULE_DEVICE_TABLE(of, ufs_qcom_of_match);
1797 static const struct acpi_device_id ufs_qcom_acpi_match[] = {
1801 MODULE_DEVICE_TABLE(acpi, ufs_qcom_acpi_match);
1804 static const struct dev_pm_ops ufs_qcom_pm_ops = {
1805 SET_RUNTIME_PM_OPS(ufshcd_runtime_suspend, ufshcd_runtime_resume, NULL)
1806 .prepare = ufshcd_suspend_prepare,
1807 .complete = ufshcd_resume_complete,
1808 #ifdef CONFIG_PM_SLEEP
1809 .suspend = ufshcd_system_suspend,
1810 .resume = ufshcd_system_resume,
1811 .freeze = ufshcd_system_freeze,
1812 .restore = ufshcd_system_restore,
1813 .thaw = ufshcd_system_thaw,
1817 static struct platform_driver ufs_qcom_pltform = {
1818 .probe = ufs_qcom_probe,
1819 .remove = ufs_qcom_remove,
1821 .name = "ufshcd-qcom",
1822 .pm = &ufs_qcom_pm_ops,
1823 .of_match_table = of_match_ptr(ufs_qcom_of_match),
1824 .acpi_match_table = ACPI_PTR(ufs_qcom_acpi_match),
1827 module_platform_driver(ufs_qcom_pltform);
1829 MODULE_LICENSE("GPL v2");