1 // SPDX-License-Identifier: GPL-2.0-only
3  * Copyright (c) 2013-2016, Linux Foundation. All rights reserved.
12 #include <linux/reset-controller.h>
16 #include "ufshcd-pltfrm.h"
18 #include "ufs-qcom.h"
64 		dev_err(hba->dev, "%s: couldn't read PA_CONNECTEDTXDATALANES %d\n",  in ufs_qcom_get_connected_tx_lanes()
84 	if (optional && err == -ENOENT) {  in ufs_qcom_host_clk_get()
89 	if (err != -EPROBE_DEFER)  in ufs_qcom_host_clk_get()
109 	if (!host->is_lane_clks_enabled)  in ufs_qcom_disable_lane_clks()
112 	clk_disable_unprepare(host->tx_l1_sync_clk);  in ufs_qcom_disable_lane_clks()
113 	clk_disable_unprepare(host->tx_l0_sync_clk);  in ufs_qcom_disable_lane_clks()
114 	clk_disable_unprepare(host->rx_l1_sync_clk);  in ufs_qcom_disable_lane_clks()
115 	clk_disable_unprepare(host->rx_l0_sync_clk);  in ufs_qcom_disable_lane_clks()
117 	host->is_lane_clks_enabled = false;  in ufs_qcom_disable_lane_clks()
123 	struct device *dev = host->hba->dev;  in ufs_qcom_enable_lane_clks()
125 	if (host->is_lane_clks_enabled)  in ufs_qcom_enable_lane_clks()
129 		host->rx_l0_sync_clk);  in ufs_qcom_enable_lane_clks()
134 		host->tx_l0_sync_clk);  in ufs_qcom_enable_lane_clks()
139 			host->rx_l1_sync_clk);  in ufs_qcom_enable_lane_clks()
144 			host->tx_l1_sync_clk);  in ufs_qcom_enable_lane_clks()
148 	host->is_lane_clks_enabled = true;  in ufs_qcom_enable_lane_clks()
152 	clk_disable_unprepare(host->rx_l1_sync_clk);  in ufs_qcom_enable_lane_clks()
154 	clk_disable_unprepare(host->tx_l0_sync_clk);  in ufs_qcom_enable_lane_clks()
156 	clk_disable_unprepare(host->rx_l0_sync_clk);  in ufs_qcom_enable_lane_clks()
164 	struct device *dev = host->hba->dev;  in ufs_qcom_init_lane_clks()
170 					&host->rx_l0_sync_clk, false);  in ufs_qcom_init_lane_clks()
175 					&host->tx_l0_sync_clk, false);  in ufs_qcom_init_lane_clks()
180 	if (host->hba->lanes_per_direction > 1) {  in ufs_qcom_init_lane_clks()
182 			&host->rx_l1_sync_clk, false);  in ufs_qcom_init_lane_clks()
187 			&host->tx_l1_sync_clk, true);  in ufs_qcom_init_lane_clks()
229 		dev_err(hba->dev, "%s: unable to get TX_FSM_STATE, err %d\n",  in ufs_qcom_check_hibern8()
233 		dev_err(hba->dev, "%s: invalid TX_FSM_STATE = %d\n",  in ufs_qcom_check_hibern8()
242 	ufshcd_rmwl(host->hba, QUNIPRO_SEL,  in ufs_qcom_select_unipro_mode()
250  * ufs_qcom_host_reset - reset host controller and PHY
258 	if (!host->core_reset) {  in ufs_qcom_host_reset()
259 		dev_warn(hba->dev, "%s: reset control not set\n", __func__);  in ufs_qcom_host_reset()
263 	reenable_intr = hba->is_irq_enabled;  in ufs_qcom_host_reset()
264 	disable_irq(hba->irq);  in ufs_qcom_host_reset()
265 	hba->is_irq_enabled = false;  in ufs_qcom_host_reset()
267 	ret = reset_control_assert(host->core_reset);  in ufs_qcom_host_reset()
269 		dev_err(hba->dev, "%s: core_reset assert failed, err = %d\n",  in ufs_qcom_host_reset()
276 	 * is at least 3-4 sleep clock (32.7KHz) cycles, which comes to  in ufs_qcom_host_reset()
281 	ret = reset_control_deassert(host->core_reset);  in ufs_qcom_host_reset()
283 		dev_err(hba->dev, "%s: core_reset deassert failed, err = %d\n",  in ufs_qcom_host_reset()
289 		enable_irq(hba->irq);  in ufs_qcom_host_reset()
290 		hba->is_irq_enabled = true;  in ufs_qcom_host_reset()
300 	struct phy *phy = host->generic_phy;  in ufs_qcom_power_up_sequence()
305 	/* Reset UFS Host Controller and PHY */  in ufs_qcom_power_up_sequence()
308 		dev_warn(hba->dev, "%s: host reset returned %d\n",  in ufs_qcom_power_up_sequence()
314 	/* phy initialization - calibrate the phy */  in ufs_qcom_power_up_sequence()
317 		dev_err(hba->dev, "%s: phy init failed, ret = %d\n",  in ufs_qcom_power_up_sequence()
322 	/* power on phy - start serdes and phy's power and clocks */  in ufs_qcom_power_up_sequence()
325 		dev_err(hba->dev, "%s: phy power on failed, ret = %d\n",  in ufs_qcom_power_up_sequence()
342  * Internal hardware sub-modules within the UTP controller control the CGCs.
343  * Hardware CGCs disable the clock to inactivate UTP sub-modules not involved
345  * this function enables them (after every UFS link startup) to save some power
375 		/* check if UFS PHY moved from DISABLED to HIBERN8 */  in ufs_qcom_hce_enable_notify()
381 		dev_err(hba->dev, "%s: invalid status %d\n", __func__, status);  in ufs_qcom_hce_enable_notify()
382 		err = -EINVAL;  in ufs_qcom_hce_enable_notify()
389  * Returns zero for success and non-zero in case of a failure
402 	static u32 pwm_fr_table[][2] = {  in ufs_qcom_cfg_timers()
409 	static u32 hs_fr_table_rA[][2] = {  in ufs_qcom_cfg_timers()
415 	static u32 hs_fr_table_rB[][2] = {  in ufs_qcom_cfg_timers()
432 		dev_err(hba->dev, "%s: invalid gear = %d\n", __func__, gear);  in ufs_qcom_cfg_timers()
436 	list_for_each_entry(clki, &hba->clk_list_head, list) {  in ufs_qcom_cfg_timers()
437 		if (!strcmp(clki->name, "core_clk"))  in ufs_qcom_cfg_timers()
438 			core_clk_rate = clk_get_rate(clki->clk);  in ufs_qcom_cfg_timers()
467 				dev_err(hba->dev,  in ufs_qcom_cfg_timers()
473 			tx_clk_cycles_per_us = hs_fr_table_rA[gear-1][1];  in ufs_qcom_cfg_timers()
476 				dev_err(hba->dev,  in ufs_qcom_cfg_timers()
482 			tx_clk_cycles_per_us = hs_fr_table_rB[gear-1][1];  in ufs_qcom_cfg_timers()
484 			dev_err(hba->dev, "%s: invalid rate = %d\n",  in ufs_qcom_cfg_timers()
492 			dev_err(hba->dev,  in ufs_qcom_cfg_timers()
498 		tx_clk_cycles_per_us = pwm_fr_table[gear-1][1];  in ufs_qcom_cfg_timers()
502 		dev_err(hba->dev, "%s: invalid mode = %d\n", __func__, hs);  in ufs_qcom_cfg_timers()
508 		/* this register 2 fields shall be written at once */  in ufs_qcom_cfg_timers()
530 	ret = -EINVAL;  in ufs_qcom_cfg_timers()
545 			dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",  in ufs_qcom_link_startup_notify()
547 			err = -EINVAL;  in ufs_qcom_link_startup_notify()
560 		 * Some UFS devices (and may be host) have issues if LCC is  in ufs_qcom_link_startup_notify()
586 	if (!host->device_reset)  in ufs_qcom_device_reset_ctrl()
589 	gpiod_set_value_cansleep(host->device_reset, asserted);  in ufs_qcom_device_reset_ctrl()
595 	struct phy *phy = host->generic_phy;  in ufs_qcom_suspend()
606 		/* reset the connected UFS device during power down */  in ufs_qcom_suspend()
619 	struct phy *phy = host->generic_phy;  in ufs_qcom_resume()
625 			dev_err(hba->dev, "%s: failed PHY power on: %d\n",  in ufs_qcom_resume()
645 	if (host->dev_ref_clk_ctrl_mmio &&  in ufs_qcom_dev_ref_clk_ctrl()
646 	    (enable ^ host->is_dev_ref_clk_enabled)) {  in ufs_qcom_dev_ref_clk_ctrl()
647 		u32 temp = readl_relaxed(host->dev_ref_clk_ctrl_mmio);  in ufs_qcom_dev_ref_clk_ctrl()
650 			temp |= host->dev_ref_clk_en_mask;  in ufs_qcom_dev_ref_clk_ctrl()
652 			temp &= ~host->dev_ref_clk_en_mask;  in ufs_qcom_dev_ref_clk_ctrl()
663 			gating_wait = host->hba->dev_info.clk_gating_wait_us;  in ufs_qcom_dev_ref_clk_ctrl()
671 				 * HS-MODE to LS-MODE or HIBERN8 state. Give it  in ufs_qcom_dev_ref_clk_ctrl()
679 		writel_relaxed(temp, host->dev_ref_clk_ctrl_mmio);  in ufs_qcom_dev_ref_clk_ctrl()
685 		readl(host->dev_ref_clk_ctrl_mmio);  in ufs_qcom_dev_ref_clk_ctrl()
695 		host->is_dev_ref_clk_enabled = enable;  in ufs_qcom_dev_ref_clk_ctrl()
710 		ret = -EINVAL;  in ufs_qcom_pwr_change_notify()
730 		if (host->hw_ver.major == 0x1) {  in ufs_qcom_pwr_change_notify()
732 			 * HS-G3 operations may not reliably work on legacy QCOM  in ufs_qcom_pwr_change_notify()
733 			 * UFS host controller hardware even though capability  in ufs_qcom_pwr_change_notify()
736 			 * Hence downgrade the maximum supported gear to HS-G2.  in ufs_qcom_pwr_change_notify()
754 		if (!ufshcd_is_hs_mode(&hba->pwr_info) &&  in ufs_qcom_pwr_change_notify()
758 		if (host->hw_ver.major >= 0x4) {  in ufs_qcom_pwr_change_notify()
759 			if (dev_req_params->gear_tx == UFS_HS_G4) {  in ufs_qcom_pwr_change_notify()
773 		if (ufs_qcom_cfg_timers(hba, dev_req_params->gear_rx,  in ufs_qcom_pwr_change_notify()
774 					dev_req_params->pwr_rx,  in ufs_qcom_pwr_change_notify()
775 					dev_req_params->hs_rate, false)) {  in ufs_qcom_pwr_change_notify()
776 			dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",  in ufs_qcom_pwr_change_notify()
783 			ret = -EINVAL;  in ufs_qcom_pwr_change_notify()
787 		memcpy(&host->dev_req_params,  in ufs_qcom_pwr_change_notify()
791 		if (ufshcd_is_hs_mode(&hba->pwr_info) &&  in ufs_qcom_pwr_change_notify()
796 		ret = -EINVAL;  in ufs_qcom_pwr_change_notify()
825 	if (hba->dev_quirks & UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME)  in ufs_qcom_apply_dev_quirks()
828 	if (hba->dev_info.wmanufacturerid == UFS_VENDOR_WDC)  in ufs_qcom_apply_dev_quirks()
829 		hba->dev_quirks |= UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE;  in ufs_qcom_apply_dev_quirks()
838 	if (host->hw_ver.major == 0x1)  in ufs_qcom_get_ufs_hci_version()
841 		return ufshci_version(2, 0);  in ufs_qcom_get_ufs_hci_version()
845  * ufs_qcom_advertise_quirks - advertise the known QCOM UFS controller quirks
848  * QCOM UFS host controller might have some non standard behaviours (quirks)
850  * quirks to standard UFS host controller driver so standard takes them into
857 	if (host->hw_ver.major == 0x01) {  in ufs_qcom_advertise_quirks()
858 		hba->quirks |= UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS  in ufs_qcom_advertise_quirks()
862 		if (host->hw_ver.minor == 0x0001 && host->hw_ver.step == 0x0001)  in ufs_qcom_advertise_quirks()
863 			hba->quirks |= UFSHCD_QUIRK_BROKEN_INTR_AGGR;  in ufs_qcom_advertise_quirks()
865 		hba->quirks |= UFSHCD_QUIRK_BROKEN_LCC;  in ufs_qcom_advertise_quirks()
868 	if (host->hw_ver.major == 0x2) {  in ufs_qcom_advertise_quirks()
869 		hba->quirks |= UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION;  in ufs_qcom_advertise_quirks()
873 			hba->quirks |= (UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS  in ufs_qcom_advertise_quirks()
883 	hba->caps |= UFSHCD_CAP_CLK_GATING | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;  in ufs_qcom_set_caps()
884 	hba->caps |= UFSHCD_CAP_CLK_SCALING;  in ufs_qcom_set_caps()
885 	hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND;  in ufs_qcom_set_caps()
886 	hba->caps |= UFSHCD_CAP_WB_EN;  in ufs_qcom_set_caps()
887 	hba->caps |= UFSHCD_CAP_CRYPTO;  in ufs_qcom_set_caps()
889 	if (host->hw_ver.major >= 0x2) {  in ufs_qcom_set_caps()
890 		host->caps = UFS_QCOM_CAP_QUNIPRO |  in ufs_qcom_set_caps()
896  * ufs_qcom_setup_clocks - enables/disable clocks
901  * Returns 0 on success, non-zero on failure.
929 			if (ufshcd_is_hs_mode(&hba->pwr_info))  in ufs_qcom_setup_clocks()
945 	ufs_qcom_assert_reset(host->hba);  in ufs_qcom_reset_assert()
958 	ufs_qcom_deassert_reset(host->hba);  in ufs_qcom_reset_deassert()
986  * ufs_qcom_init - bind phy with controller
992  * Returns -EPROBE_DEFER if binding fails, returns negative error
998 	struct device *dev = hba->dev;  in ufs_qcom_init()
1004 		return -ENODEV;  in ufs_qcom_init()
1008 		err = -ENOMEM;  in ufs_qcom_init()
1009 		dev_err(dev, "%s: no memory for qcom ufs host\n", __func__);  in ufs_qcom_init()
1014 	host->hba = hba;  in ufs_qcom_init()
1018 	host->core_reset = devm_reset_control_get(hba->dev, "rst");  in ufs_qcom_init()
1019 	if (IS_ERR(host->core_reset)) {  in ufs_qcom_init()
1020 		err = PTR_ERR(host->core_reset);  in ufs_qcom_init()
1022 		host->core_reset = NULL;  in ufs_qcom_init()
1026 	/* Fire up the reset controller. Failure here is non-fatal. */  in ufs_qcom_init()
1027 	host->rcdev.of_node = dev->of_node;  in ufs_qcom_init()
1028 	host->rcdev.ops = &ufs_qcom_reset_ops;  in ufs_qcom_init()
1029 	host->rcdev.owner = dev->driver->owner;  in ufs_qcom_init()
1030 	host->rcdev.nr_resets = 1;  in ufs_qcom_init()
1031 	err = devm_reset_controller_register(dev, &host->rcdev);  in ufs_qcom_init()
1042 	host->generic_phy = devm_phy_get(dev, "ufsphy");  in ufs_qcom_init()
1044 	if (host->generic_phy == ERR_PTR(-EPROBE_DEFER)) {  in ufs_qcom_init()
1046 		 * UFS driver might be probed before the phy driver does.  in ufs_qcom_init()
1049 		err = -EPROBE_DEFER;  in ufs_qcom_init()
1053 	} else if (IS_ERR(host->generic_phy)) {  in ufs_qcom_init()
1055 			host->generic_phy = NULL;  in ufs_qcom_init()
1057 			err = PTR_ERR(host->generic_phy);  in ufs_qcom_init()
1063 	host->device_reset = devm_gpiod_get_optional(dev, "reset",  in ufs_qcom_init()
1065 	if (IS_ERR(host->device_reset)) {  in ufs_qcom_init()
1066 		err = PTR_ERR(host->device_reset);  in ufs_qcom_init()
1067 		if (err != -EPROBE_DEFER)  in ufs_qcom_init()
1072 	ufs_qcom_get_controller_revision(hba, &host->hw_ver.major,  in ufs_qcom_init()
1073 		&host->hw_ver.minor, &host->hw_ver.step);  in ufs_qcom_init()
1077 	 * moved inside UFS controller register address space itself.  in ufs_qcom_init()
1079 	if (host->hw_ver.major >= 0x02) {  in ufs_qcom_init()
1080 		host->dev_ref_clk_ctrl_mmio = hba->mmio_base + REG_UFS_CFG1;  in ufs_qcom_init()
1081 		host->dev_ref_clk_en_mask = BIT(26);  in ufs_qcom_init()
1087 			host->dev_ref_clk_ctrl_mmio =  in ufs_qcom_init()
1089 			if (IS_ERR(host->dev_ref_clk_ctrl_mmio)) {  in ufs_qcom_init()
1093 					PTR_ERR(host->dev_ref_clk_ctrl_mmio));  in ufs_qcom_init()
1094 				host->dev_ref_clk_ctrl_mmio = NULL;  in ufs_qcom_init()
1096 			host->dev_ref_clk_en_mask = BIT(5);  in ufs_qcom_init()
1113 	if (hba->dev->id < MAX_UFS_QCOM_HOSTS)  in ufs_qcom_init()
1114 		ufs_qcom_hosts[hba->dev->id] = host;  in ufs_qcom_init()
1116 	host->dbg_print_en |= UFS_QCOM_DEFAULT_DBG_PRINT_EN;  in ufs_qcom_init()
1138 	phy_power_off(host->generic_phy);  in ufs_qcom_exit()
1139 	phy_exit(host->generic_phy);  in ufs_qcom_exit()
1149 		return -EINVAL;  in ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div()
1227 	struct ufs_pa_layer_attr *dev_req_params = &host->dev_req_params;  in ufs_qcom_clk_scale_notify()
1254 				    dev_req_params->gear_rx,  in ufs_qcom_clk_scale_notify()
1255 				    dev_req_params->pwr_rx,  in ufs_qcom_clk_scale_notify()
1256 				    dev_req_params->hs_rate,  in ufs_qcom_clk_scale_notify()
1277 		dev_err(hba->dev, "%s: print_fn is NULL\n", __func__);  in ufs_qcom_print_hw_debug_reg_all()
1282 	if (!(host->dbg_print_en & UFS_QCOM_DBG_PRINT_REGS_EN))  in ufs_qcom_print_hw_debug_reg_all()
1301 	/* clear bit 17 - UTP_DBG_RAMS_EN */  in ufs_qcom_print_hw_debug_reg_all()
1328 	if (host->dbg_print_en & UFS_QCOM_DBG_PRINT_TEST_BUS_EN) {  in ufs_qcom_enable_test_bus()
1329 		ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN,  in ufs_qcom_enable_test_bus()
1331 		ufshcd_rmwl(host->hba, TEST_BUS_EN, TEST_BUS_EN, REG_UFS_CFG1);  in ufs_qcom_enable_test_bus()
1333 		ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN, 0, REG_UFS_CFG1);  in ufs_qcom_enable_test_bus()
1334 		ufshcd_rmwl(host->hba, TEST_BUS_EN, 0, REG_UFS_CFG1);  in ufs_qcom_enable_test_bus()
1341 	host->testbus.select_major = TSTBUS_UNIPRO;  in ufs_qcom_get_default_testbus_cfg()
1342 	host->testbus.select_minor = 37;  in ufs_qcom_get_default_testbus_cfg()
1347 	if (host->testbus.select_major >= TSTBUS_MAX) {  in ufs_qcom_testbus_cfg_is_ok()
1348 		dev_err(host->hba->dev,  in ufs_qcom_testbus_cfg_is_ok()
1350 			__func__, host->testbus.select_major);  in ufs_qcom_testbus_cfg_is_ok()
1364 		return -EINVAL;  in ufs_qcom_testbus_config()
1367 		return -EPERM;  in ufs_qcom_testbus_config()
1369 	switch (host->testbus.select_major) {  in ufs_qcom_testbus_config()
1426 	ufshcd_rmwl(host->hba, TEST_BUS_SEL,  in ufs_qcom_testbus_config()
1427 		    (u32)host->testbus.select_major << 19,  in ufs_qcom_testbus_config()
1429 	ufshcd_rmwl(host->hba, mask,  in ufs_qcom_testbus_config()
1430 		    (u32)host->testbus.select_minor << offset,  in ufs_qcom_testbus_config()
1451  * ufs_qcom_device_reset() - toggle the (optional) device reset line
1452  * @hba: per-adapter instance
1461 	if (!host->device_reset)  in ufs_qcom_device_reset()
1462 		return -EOPNOTSUPP;  in ufs_qcom_device_reset()
1465 	 * The UFS device shall detect reset pulses of 1us, sleep for 10us to  in ufs_qcom_device_reset()
1488 	p->polling_ms = 60;  in ufs_qcom_config_scaling_param()
1489 	d->upthreshold = 70;  in ufs_qcom_config_scaling_param()
1490 	d->downdifferential = 5;  in ufs_qcom_config_scaling_param()
1501  * struct ufs_hba_qcom_vops - UFS QCOM specific variant operations
1526  * ufs_qcom_probe - probe routine of the driver
1529  * Return zero for success and non-zero for failure
1534 	struct device *dev = &pdev->dev;  in ufs_qcom_probe()
1545  * ufs_qcom_remove - set driver_data of the device to NULL
1554 	pm_runtime_get_sync(&(pdev)->dev);  in ufs_qcom_remove()
1586 		.name	= "ufshcd-qcom",