To support the fuction of writebooster by vendor.
The WB behavior that the vendor wants is slightly different.
But we have to support it
Signed-off-by: SEO HOYOUNG <hy50.seo@xxxxxxxxxxx>
---
drivers/scsi/ufs/Kconfig | 8 +
drivers/scsi/ufs/Makefile | 1 +
drivers/scsi/ufs/ufs-exynos.c | 6 +
drivers/scsi/ufs/ufs_ctmwb.c | 270 ++++++++++++++++++++++++++++++++++
drivers/scsi/ufs/ufs_ctmwb.h | 26 ++++
drivers/scsi/ufs/ufshcd.c | 3 +-
drivers/scsi/ufs/ufshcd.h | 4 -
7 files changed, 312 insertions(+), 6 deletions(-)
create mode 100644 drivers/scsi/ufs/ufs_ctmwb.c
create mode 100644 drivers/scsi/ufs/ufs_ctmwb.h
diff --git a/drivers/scsi/ufs/Kconfig b/drivers/scsi/ufs/Kconfig
index 46a4542f37eb..b7db2367d3bc 100644
--- a/drivers/scsi/ufs/Kconfig
+++ b/drivers/scsi/ufs/Kconfig
@@ -173,6 +173,14 @@ config SCSI_UFS_EXYNOS
Select this if you have UFS host controller on EXYNOS chipset.
If unsure, say N.
+config CONFIG_SCSI_UFS_VENDOR_WB
+ tristate "Write Booster Vendor specific feature support"
+ depends on SCSI_UFSHCD
+ help
+ Enable Write Booster vendor specific.
+ Enable this operation disables WB on the probe.
+ Will check the WB buffer and flush operation before entering the suspend.
+
config SCSI_UFS_CRYPTO
bool "UFS Crypto Engine Support"
depends on SCSI_UFSHCD && BLK_INLINE_ENCRYPTION
diff --git a/drivers/scsi/ufs/Makefile b/drivers/scsi/ufs/Makefile
index 9810963bc049..b1ba36c7d66f 100644
--- a/drivers/scsi/ufs/Makefile
+++ b/drivers/scsi/ufs/Makefile
@@ -5,6 +5,7 @@ obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-d
obj-$(CONFIG_SCSI_UFS_CDNS_PLATFORM) += cdns-pltfrm.o
obj-$(CONFIG_SCSI_UFS_QCOM) += ufs-qcom.o
obj-$(CONFIG_SCSI_UFS_EXYNOS) += ufs-exynos.o
+obj-$(CONFIG_SCSI_UFS_VENDOR_WB) += ufs_ctmwb.o
obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o
ufshcd-core-y += ufshcd.o ufs-sysfs.o
ufshcd-core-$(CONFIG_SCSI_UFS_BSG) += ufs_bsg.o
diff --git a/drivers/scsi/ufs/ufs-exynos.c b/drivers/scsi/ufs/ufs-exynos.c
index 32b61ba77241..f127f5f2bf36 100644
--- a/drivers/scsi/ufs/ufs-exynos.c
+++ b/drivers/scsi/ufs/ufs-exynos.c
@@ -22,6 +22,9 @@
#include "ufs-exynos.h"
+#ifdef CONFIG_SCSI_UFS_VENDOR_WB
+#include "ufs_ctmwb.h"
+#endif
/*
* Exynos's Vendor specific registers for UFSHCI
*/
@@ -989,6 +992,9 @@ static int exynos_ufs_init(struct ufs_hba *hba)
goto phy_off;
ufs->hba = hba;
+#ifdef CONFIG_SCSI_UFS_VENDOR_WB
+ ufs->hba->wb_ops = ufshcd_ctmwb_init();
+#endif
ufs->opts = ufs->drv_data->opts;
ufs->rx_sel_idx = PA_MAXDATALANES;
if (ufs->opts & EXYNOS_UFS_OPT_BROKEN_RX_SEL_IDX)
diff --git a/drivers/scsi/ufs/ufs_ctmwb.c b/drivers/scsi/ufs/ufs_ctmwb.c
new file mode 100644
index 000000000000..e1cad936ebb3
--- /dev/null
+++ b/drivers/scsi/ufs/ufs_ctmwb.c
@@ -0,0 +1,270 @@
+#include "ufshcd.h"
+#include "ufshci.h"
+#include "ufs_ctmwb.h"
+
+static struct ufshba_ctmwb hba_ctmwb;
+
+/* Query request retries */
+#define QUERY_REQ_RETRIES 3
+
+static int ufshcd_query_attr_retry(struct ufs_hba *hba,
+ enum query_opcode opcode, enum attr_idn idn, u8 index, u8 selector,
+ u32 *attr_val)
+{
+ int ret = 0;
+ u32 retries;
+
+ for (retries = QUERY_REQ_RETRIES; retries > 0; retries--) {
+ ret = ufshcd_query_attr(hba, opcode, idn, index,
+ selector, attr_val);
+ if (ret)
+ dev_dbg(hba->dev, "%s: failed with error %d, retries %d\n",
+ __func__, ret, retries);
+ else
+ break;
+ }
+
+ if (ret)
+ dev_err(hba->dev,
+ "%s: query attribute, idn %d, failed with error %d after %d retires\n",
+ __func__, idn, ret, QUERY_REQ_RETRIES);
+ return ret;
+}
+
+static int ufshcd_query_flag_retry(struct ufs_hba *hba,
+ enum query_opcode opcode, enum flag_idn idn, bool *flag_res)
+{
+ int ret;
+ int retries;
+
+ for (retries = 0; retries < QUERY_REQ_RETRIES; retries++) {
+ ret = ufshcd_query_flag(hba, opcode, idn, flag_res);
+ if (ret)
+ dev_dbg(hba->dev,
+ "%s: failed with error %d, retries %d\n",
+ __func__, ret, retries);
+ else
+ break;
+ }
+
+ if (ret)
+ dev_err(hba->dev,
+ "%s: query attribute, opcode %d, idn %d, failed with error %d after %d retries\n",
+ __func__, (int)opcode, (int)idn, ret, retries);
+ return ret;
+}
+
+static int ufshcd_reset_ctmwb(struct ufs_hba *hba, bool force)
+{
+ int err = 0;
+
+ if (!ufshcd_is_wb_allowed(hba))
+ return 0;
+
+ if (ufshcd_is_ctmwb_off(hba_ctmwb)) {
+ dev_info(hba->dev, "%s: write booster already disabled. ctmwb_state = %d\n",
+ __func__, hba_ctmwb.ufs_ctmwb_state);
+ return 0;
+ }
+
+ if (ufshcd_is_ctmwb_err(hba_ctmwb))
+ dev_err(hba->dev, "%s: previous write booster control was failed.\n",
+ __func__);
+
+ if (force)
+ err = ufshcd_query_flag_retry(hba, UPIU_QUERY_OPCODE_CLEAR_FLAG,
+ QUERY_FLAG_IDN_WB_EN, NULL);
+
+ if (err) {
+ ufshcd_set_ctmwb_err(hba_ctmwb);
+ dev_err(hba->dev, "%s: disable write booster failed. err = %d\n",
+ __func__, err);
+ } else {
+ ufshcd_set_ctmwb_off(hba_ctmwb);
+ dev_info(hba->dev, "%s: ufs write booster disabled \n", __func__);
+ }
+
+ return 0;
+}
+
+static int ufshcd_get_ctmwb_buf_status(struct ufs_hba *hba, u32 *status)
+{
+ return ufshcd_query_attr_retry(hba, UPIU_QUERY_OPCODE_READ_ATTR,
+ QUERY_ATTR_IDN_AVAIL_WB_BUFF_SIZE, 0, 0, status);
+}
+
+static int ufshcd_ctmwb_manual_flush_ctrl(struct ufs_hba *hba, int en)
+{
+ int err = 0;
+
+ dev_info(hba->dev, "%s: %sable write booster manual flush\n",
+ __func__, en ? "en" : "dis");
+ if (en) {
+ err = ufshcd_query_flag_retry(hba, UPIU_QUERY_OPCODE_SET_FLAG,
+ QUERY_FLAG_IDN_WB_BUFF_FLUSH_EN, NULL);
+ if (err)
+ dev_err(hba->dev, "%s: enable write booster failed. err = %d\n",
+ __func__, err);
+ } else {
+ err = ufshcd_query_flag_retry(hba, UPIU_QUERY_OPCODE_CLEAR_FLAG,
+ QUERY_FLAG_IDN_WB_BUFF_FLUSH_EN, NULL);
+ if (err)
+ dev_err(hba->dev, "%s: disable write booster failed. err = %d\n",
+ __func__, err);
+ }
+
+ return err;
+}
+
+static int ufshcd_ctmwb_flush_ctrl(struct ufs_hba *hba)
+{
+ int err = 0;
+ u32 curr_status = 0;
+
+ err = ufshcd_get_ctmwb_buf_status(hba, &curr_status);
+
+ if (!err && (curr_status <= UFS_WB_MANUAL_FLUSH_THRESHOLD)) {
+ dev_info(hba->dev, "%s: enable ctmwb manual flush, buf status : %d\n",
+ __func__, curr_status);
+ scsi_block_requests(hba->host);
+ err = ufshcd_ctmwb_manual_flush_ctrl(hba, 1);
+ if (!err) {
+ mdelay(100);
+ err = ufshcd_ctmwb_manual_flush_ctrl(hba, 0);
+ if (err)
+ dev_err(hba->dev, "%s: disable ctmwb manual flush failed. err = %d\n",
+ __func__, err);
+ } else
+ dev_err(hba->dev, "%s: enable ctmwb manual flush failed. err = %d\n",
+ __func__, err);
+ scsi_unblock_requests(hba->host);
+ }
+ return err;
+}
+
+static int ufshcd_ctmwb_ctrl(struct ufs_hba *hba, bool enable)
+{
+ int err;
+
+ if (!ufshcd_is_wb_allowed(hba))
+ return 0;
+
+ if (hba->pm_op_in_progress) {
+ dev_err(hba->dev, "%s: ctmwb ctrl during pm operation is not allowed.\n",
+ __func__);
+ return 0;
+ }
+
+ if (ufshcd_is_ctmwb_err(hba_ctmwb))
+ dev_err(hba->dev, "%s: previous write booster control was failed.\n",
+ __func__);
+ if (enable) {
+ if (ufshcd_is_ctmwb_on(hba_ctmwb)) {
+ dev_err(hba->dev, "%s: write booster already enabled. ctmwb_state = %d\n",
+ __func__, hba_ctmwb.ufs_ctmwb_state);
+ return 0;
+ }
+ pm_runtime_get_sync(hba->dev);
+ err = ufshcd_query_flag_retry(hba, UPIU_QUERY_OPCODE_SET_FLAG,
+ QUERY_FLAG_IDN_WB_EN, NULL);
+ if (err) {
+ ufshcd_set_ctmwb_err(hba_ctmwb);
+ dev_err(hba->dev, "%s: enable write booster failed. err = %d\n",
+ __func__, err);
+ } else {
+ ufshcd_set_ctmwb_on(hba_ctmwb);
+ dev_info(hba->dev, "%s: ufs write booster enabled \n", __func__);
+ }
+ } else {
+ if (ufshcd_is_ctmwb_off(hba_ctmwb)) {
+ dev_err(hba->dev, "%s: write booster already disabled. ctmwb_state = %d\n",
+ __func__, hba_ctmwb.ufs_ctmwb_state);
+ return 0;
+ }
+ pm_runtime_get_sync(hba->dev);
+ err = ufshcd_query_flag_retry(hba, UPIU_QUERY_OPCODE_CLEAR_FLAG,
+ QUERY_FLAG_IDN_WB_EN, NULL);
+ if (err) {
+ ufshcd_set_ctmwb_err(hba_ctmwb);
+ dev_err(hba->dev, "%s: disable write booster failed. err = %d\n",
+ __func__, err);
+ } else {
+ ufshcd_set_ctmwb_off(hba_ctmwb);
+ dev_info(hba->dev, "%s: ufs write booster disabled \n", __func__);
+ }
+ }
+
+ pm_runtime_put_sync(hba->dev);
+
+ return 0;
+}
+
+/**
+ * ufshcd_get_ctmwbbuf_unit - get ctmwb buffer alloc units
+ * @sdev: pointer to SCSI device
+ *
+ * Read dLUNumTurboWriteBufferAllocUnits in UNIT Descriptor
+ * to check if LU supports write booster feature
+ */
+static int ufshcd_get_ctmwbbuf_unit(struct ufs_hba *hba)
+{
+ struct scsi_device *sdev = hba->sdev_ufs_device;
+ struct ufshba_ctmwb *hba_ctmwb = (struct ufshba_ctmwb *)hba->wb_ops;
+ int ret = 0;
+
+ u32 dLUNumTurboWriteBufferAllocUnits = 0;
+ u8 desc_buf[4];
+
+ if (!ufshcd_is_wb_allowed(hba))
+ return 0;
+
+ ret = ufshcd_read_unit_desc_param(hba,
+ ufshcd_scsi_to_upiu_lun(sdev->lun),
+ UNIT_DESC_PARAM_WB_BUF_ALLOC_UNITS,
+ desc_buf,
+ sizeof(dLUNumTurboWriteBufferAllocUnits));
+
+ /* Some WLUN doesn't support unit descriptor */
+ if ((ret == -EOPNOTSUPP) || scsi_is_wlun(sdev->lun)){
+ hba_ctmwb->support_ctmwb_lu = false;
+ dev_info(hba->dev,"%s: do not support WB\n", __func__);
+ return 0;
+ }
+
+ dLUNumTurboWriteBufferAllocUnits = ((desc_buf[0] << 24)|
+ (desc_buf[1] << 16) |
+ (desc_buf[2] << 8) |
+ desc_buf[3]);
+
+ if (dLUNumTurboWriteBufferAllocUnits) {
+ hba_ctmwb->support_ctmwb_lu = true;
+ dev_info(hba->dev, "%s: LU %d supports ctmwb, ctmwbbuf unit : 0x%x\n",
+ __func__, (int)sdev->lun, dLUNumTurboWriteBufferAllocUnits);
+ } else
+ hba_ctmwb->support_ctmwb_lu = false;
+
+ return 0;
+}
+
+static inline int ufshcd_ctmwb_toggle_flush(struct ufs_hba *hba, enum ufs_pm_op pm_op)
+{
+ ufshcd_ctmwb_flush_ctrl(hba);
+
+ if (ufshcd_is_system_pm(pm_op))
+ ufshcd_reset_ctmwb(hba, true);
+
+ return 0;
+}
+
+static struct ufs_wb_ops exynos_ctmwb_ops = {
+ .wb_toggle_flush_vendor = ufshcd_ctmwb_toggle_flush,
+ .wb_alloc_units_vendor = ufshcd_get_ctmwbbuf_unit,
+ .wb_ctrl_vendor = ufshcd_ctmwb_ctrl,
+ .wb_reset_vendor = ufshcd_reset_ctmwb,
+};
+
+struct ufs_wb_ops *ufshcd_ctmwb_init(void)
+{
+ return &exynos_ctmwb_ops;
+}
+EXPORT_SYMBOL_GPL(ufshcd_ctmwb_init);
diff --git a/drivers/scsi/ufs/ufs_ctmwb.h b/drivers/scsi/ufs/ufs_ctmwb.h
new file mode 100644
index 000000000000..e88b71824a2f
--- /dev/null
+++ b/drivers/scsi/ufs/ufs_ctmwb.h
@@ -0,0 +1,26 @@
+#ifndef _UFS_CTMWB_H_
+#define _UFS_CTMWB_H_
+
+enum ufs_ctmwb_state {
+ UFS_WB_OFF_STATE = 0, /* turbo write disabled state */
+ UFS_WB_ON_STATE = 1, /* turbo write enabled state */
+ UFS_WB_ERR_STATE = 2, /* turbo write error state */
+};
+
+#define ufshcd_is_ctmwb_off(hba) ((hba).ufs_ctmwb_state == UFS_WB_OFF_STATE)
+#define ufshcd_is_ctmwb_on(hba) ((hba).ufs_ctmwb_state == UFS_WB_ON_STATE)
+#define ufshcd_is_ctmwb_err(hba) ((hba).ufs_ctmwb_state == UFS_WB_ERR_STATE)
+#define ufshcd_set_ctmwb_off(hba) ((hba).ufs_ctmwb_state = UFS_WB_OFF_STATE)
+#define ufshcd_set_ctmwb_on(hba) ((hba).ufs_ctmwb_state = UFS_WB_ON_STATE)
+#define ufshcd_set_ctmwb_err(hba) ((hba).ufs_ctmwb_state = UFS_WB_ERR_STATE)
+
+#define UFS_WB_MANUAL_FLUSH_THRESHOLD 5
+
+struct ufshba_ctmwb {
+ enum ufs_ctmwb_state ufs_ctmwb_state;
+
+ bool support_ctmwb_lu;
+};
+
+struct ufs_wb_ops *ufshcd_ctmwb_init(void);
+#endif
diff --git a/drivers/scsi/ufs/ufshcd.c b/drivers/scsi/ufs/ufshcd.c
index 3eb139406a7c..78c4cfc4b635 100644
--- a/drivers/scsi/ufs/ufshcd.c
+++ b/drivers/scsi/ufs/ufshcd.c
@@ -3306,7 +3306,7 @@ int ufshcd_read_string_desc(struct ufs_hba *hba, u8 desc_index,
*
* Return 0 in case of success, non-zero otherwise
*/
-int ufshcd_read_unit_desc_param(struct ufs_hba *hba,
+static inline int ufshcd_read_unit_desc_param(struct ufs_hba *hba,
int lun,
enum unit_desc_param param_offset,
u8 *param_read_buf,
@@ -3322,7 +3322,6 @@ int ufshcd_read_unit_desc_param(struct ufs_hba *hba,
return ufshcd_read_desc_param(hba, QUERY_DESC_IDN_UNIT, lun,
param_offset, param_read_buf, param_size);
}
-EXPORT_SYMBOL_GPL(ufshcd_read_unit_desc_param);
static int ufshcd_get_ref_clk_gating_wait(struct ufs_hba *hba)
{
diff --git a/drivers/scsi/ufs/ufshcd.h b/drivers/scsi/ufs/ufshcd.h
index 61ae5259c62a..366f3b4634a7 100644
--- a/drivers/scsi/ufs/ufshcd.h
+++ b/drivers/scsi/ufs/ufshcd.h
@@ -1012,10 +1012,6 @@ int ufshcd_exec_raw_upiu_cmd(struct ufs_hba *hba,
u8 *desc_buff, int *buff_len,
enum query_opcode desc_op);
-int ufshcd_read_unit_desc_param(struct ufs_hba *hba,
- int lun, enum unit_desc_param param_offset,
- u8 *param_read_buf, u32 param_size);
-
/* Wrapper functions for safely calling variant operations */
static inline const char *ufshcd_get_var_name(struct ufs_hba *hba)
{
--
2.26.0
