1 /* SPDX-License-Identifier: GPL-2.0-or-later */
4  * Copyright (C) 2011-2013 Samsung India Software Operations
5  * Copyright (c) 2013-2016, The Linux Foundation. All rights reserved.
16 #include <linux/blk-crypto-profile.h>
17 #include <linux/blk-mq.h>
19 #include <linux/fault-inject.h>
23 #include <linux/dma-direction.h>
26 #include <ufs/unipro.h>
27 #include <ufs/ufs.h>
28 #include <ufs/ufs_quirks.h>
29 #include <ufs/ufshci.h>
68  * struct uic_command - UIC command structure
92 /* Host <-> Device UniPro Link state */
100 #define ufshcd_is_link_off(hba) ((hba)->uic_link_state == UIC_LINK_OFF_STATE)
101 #define ufshcd_is_link_active(hba) ((hba)->uic_link_state == \
103 #define ufshcd_is_link_hibern8(hba) ((hba)->uic_link_state == \
105 #define ufshcd_is_link_broken(hba) ((hba)->uic_link_state == \
107 #define ufshcd_set_link_off(hba) ((hba)->uic_link_state = UIC_LINK_OFF_STATE)
108 #define ufshcd_set_link_active(hba) ((hba)->uic_link_state = \
110 #define ufshcd_set_link_hibern8(hba) ((hba)->uic_link_state = \
112 #define ufshcd_set_link_broken(hba) ((hba)->uic_link_state = \
116 	((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE)
118 	((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE)
120 	((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE)
122 	((h)->curr_dev_pwr_mode = UFS_DEEPSLEEP_PWR_MODE)
124 	((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE)
126 	((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE)
128 	((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE)
130 	((h)->curr_dev_pwr_mode == UFS_DEEPSLEEP_PWR_MODE)
133  * UFS Power management levels.
155  * struct ufshcd_lrb - local reference block
166  * @command_type: SCSI, UFS, Query.
174  * @crypto_key_slot: the key slot to use for inline crypto (-1 if none)
194 	u8 lun; /* UPIU LUN id field is only 8-bit wide */
209  * struct ufs_query_req - parameters for building a query request
219  * struct ufs_query_resp - UPIU QUERY
228  * struct ufs_query - holds relevant data structures for query request
240  * struct ufs_dev_cmd - all assosiated fields with device management commands
241  * @type: device management command type - Query, NOP OUT
254  * struct ufs_clk_info - UFS clock related info
255  * @list: list headed by hba->clk_list_head
297  * struct ufs_hba_variant_ops - variant specific callbacks
302  * @get_ufs_hci_version: called to get UFS HCI version
306  *                     variant specific Uni-Pro initialization.
308  *                       to allow variant specific Uni-Pro initialization.
323  * @device_reset: called to issue a reset pulse on the UFS device
326  * @fill_crypto_prdt: initialize crypto-related fields in the PRDT
397  * struct ufs_clk_gating - UFS clock gating related info
429  * struct ufs_clk_scaling - UFS clock scaling related data
431  * devfreq ->target() function is called then schedule "suspend_work" to
437  * @saved_pwr_info: UFS power mode may also be changed during scaling and this
474  * struct ufs_event_hist - keeps history of errors
488  * struct ufs_stats - keeps usage/err statistics
492  *		reset this after link-startup.
507  * enum ufshcd_state - UFS host controller state
538 	 * If UFS host controller is having issue in processing LCC (Line
541 	 * the LCC transmission on UFS device (by clearing TX_LCC_ENABLE
563 	 * is enabled, standard UFS host driver will call the vendor specific
599 	 * auto-hibernate capability but it doesn't work.
628 	 * 64-bit addressing supported capability but it doesn't work.
634 	 * auto-hibernate capability but it's FASTAUTO only.
704 	 * This capability allows host controller driver to use the UFS HCI's
706 	 * CAUTION: Enabling this might reduce overall UFS throughput.
711 	 * This capability allows the device auto-bkops to be always enabled
727 	 * This capability allows the host controller driver to turn-on
748 	 * if it is supported by the UFS device. The host controller driver must
749 	 * support device hardware reset via the hba->device_reset() callback,
756 	 * notification if it is supported by the UFS device.
794  * struct ufshcd_res_info_t - MCQ related resource regions
818  * struct ufshcd_mcq_opr_info_t - Operation and Runtime registers
839  * struct ufs_hba - per adapter private structure
841  * @ucdl_base_addr: UFS Command Descriptor base address
844  * @ucdl_dma_addr: UFS Command Descriptor DMA address
849  * @ufs_device_wlun: WLUN that controls the entire UFS device.
851  * @curr_dev_pwr_mode: active UFS device power mode.
852  * @uic_link_state: active state of the link to the UFS device.
853  * @rpm_lvl: desired UFS power management level during runtime PM.
854  * @spm_lvl: desired UFS power management level during system PM.
856  * @ahit: value of Auto-Hibernate Idle Timer register.
861  * @capabilities: UFS Controller Capabilities
862  * @mcq_capabilities: UFS Multi Circular Queue capabilities
864  * @nortt - Max outstanding RTTs supported by controller
867  * @ufs_version: UFS Version to which controller complies
873  * @is_irq_enabled: whether or not the UFS controller interrupt is enabled.
876  * @dev_quirks: bitmask with information about deviations from the UFS standard.
894  * @eh_work: Worker to handle UFS errors that require s/w attention
897  * @uic_error: UFS interconnect layer error status
904  * @dev_cmd: ufs device management command information
907  * @dev_info: information about the UFS device
909  * @vreg_info: UFS device voltage regulator information
910  * @clk_list_head: UFS host controller clocks list node head
913  * @lanes_per_direction: number of lanes per data direction between the UFS
914  *	controller and the UFS device.
918  * @caps: bitmask with information about UFS controller capabilities
920  * @clk_scaling: frequency scaling information owned by the UFS driver
923  * @is_sys_suspended: UFS device has been suspended because of system suspend
932  * @bsg_queue: BSG queue associated with the UFS controller
934  *	management) after the UFS device has finished a WriteBooster buffer
936  * @monitor: statistics about UFS commands
941  * @debugfs_root: UFS controller debugfs root directory
945  * @luns_avail: number of regular and well known LUNs supported by the UFS
959  * @ufs_rtc_update_work: A work for UFS RTC periodic update
986 	/* Desired UFS power management level during runtime PM */
988 	/* Desired UFS power management level during system PM */
992 	/* Auto-Hibernate Idle Timer register value */
1020 	/* Device deviations from standard UFS device spec. */
1062 	/* Keeps information of the UFS device connected to this host */
1135  * struct ufs_hw_queue - per hardware queue structure
1179 	return hba->mcq_opr[opr].offset + hba->mcq_opr[opr].stride * idx;  in ufshcd_mcq_opr_offset()
1190 	return hba->sg_entry_size;  in ufshcd_sg_entry_size()
1196 	hba->sg_entry_size = sg_entry_size;  in ufshcd_set_sg_entry_size()
1216 	return hba->caps & UFSHCD_CAP_CLK_GATING;  in ufshcd_is_clkgating_allowed()
1220 	return hba->caps & UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;  in ufshcd_can_hibern8_during_gating()
1224 	return hba->caps & UFSHCD_CAP_CLK_SCALING;  in ufshcd_is_clkscaling_supported()
1228 	return hba->caps & UFSHCD_CAP_AUTO_BKOPS_SUSPEND;  in ufshcd_can_autobkops_during_suspend()
1232 	return hba->caps & UFSHCD_CAP_RPM_AUTOSUSPEND;  in ufshcd_is_rpm_autosuspend_allowed()
1237 	return (hba->caps & UFSHCD_CAP_INTR_AGGR) &&  in ufshcd_is_intr_aggr_allowed()
1238 		!(hba->quirks & UFSHCD_QUIRK_BROKEN_INTR_AGGR);  in ufshcd_is_intr_aggr_allowed()
1244 		  (hba->caps & UFSHCD_CAP_AGGR_POWER_COLLAPSE));  in ufshcd_can_aggressive_pc()
1249 	return (hba->capabilities & MASK_AUTO_HIBERN8_SUPPORT) &&  in ufshcd_is_auto_hibern8_supported()
1250 		!(hba->quirks & UFSHCD_QUIRK_BROKEN_AUTO_HIBERN8);  in ufshcd_is_auto_hibern8_supported()
1255 	return FIELD_GET(UFSHCI_AHIBERN8_TIMER_MASK, hba->ahit);  in ufshcd_is_auto_hibern8_enabled()
1260 	return hba->caps & UFSHCD_CAP_WB_EN;  in ufshcd_is_wb_allowed()
1265 	return hba->caps & UFSHCD_CAP_WB_WITH_CLK_SCALING;  in ufshcd_enable_wb_if_scaling_up()
1269 	writel((val), (hba)->mcq_base + (reg))
1271 	readl((hba)->mcq_base + (reg))
1274 	writel_relaxed((val), (hba)->mcq_base + (reg))
1276 	readl_relaxed((hba)->mcq_base + (reg))
1279 	writel((val), (hba)->mmio_base + (reg))
1281 	readl((hba)->mmio_base + (reg))
1284  * ufshcd_rmwl - perform read/modify/write for a controller register
1331  * ufshcd_set_variant - set variant specific data to the hba
1338 	hba->priv = variant;  in ufshcd_set_variant()
1342  * ufshcd_get_variant - get variant specific data from the hba
1348 	return hba->priv;  in ufshcd_get_variant()
1422 	return (pwr_info->pwr_rx == FAST_MODE ||  in ufshcd_is_hs_mode()
1423 		pwr_info->pwr_rx == FASTAUTO_MODE) &&  in ufshcd_is_hs_mode()
1424 		(pwr_info->pwr_tx == FAST_MODE ||  in ufshcd_is_hs_mode()
1425 		pwr_info->pwr_tx == FASTAUTO_MODE);  in ufshcd_is_hs_mode()
1463 /* Wrapper functions for safely calling variant operations */
1466 	if (hba->vops && hba->vops->init)  in ufshcd_vops_init()
1467 		return hba->vops->init(hba);  in ufshcd_vops_init()
1474 	if (hba->vops && hba->vops->phy_initialization)  in ufshcd_vops_phy_initialization()
1475 		return hba->vops->phy_initialization(hba);  in ufshcd_vops_phy_initialization()