]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
scsi: ufs: ufs-qcom: Implement vops get_rx_fom()
authorCan Guo <can.guo@oss.qualcomm.com>
Wed, 25 Mar 2026 15:21:52 +0000 (08:21 -0700)
committerMartin K. Petersen <martin.petersen@oracle.com>
Fri, 27 Mar 2026 21:20:30 +0000 (17:20 -0400)
On some platforms, host's M-PHY RX_FOM Attribute always reads 0, meaning SW
cannot rely on Figure of Merit (FOM) to identify the optimal TX
Equalization settings for device's TX Lanes. Implement the vops
ufs_qcom_get_rx_fom() such that SW can utilize the UFS Eye Opening Monitor
(EOM) to evaluate the TX Equalization settings for device's TX Lanes.

Reviewed-by: Bean Huo <beanhuo@micron.com>
Reviewed-by: Bart Van Assche <bvanassche@acm.org>
Signed-off-by: Can Guo <can.guo@oss.qualcomm.com>
Reviewed-by: Peter Wang <peter.wang@mediatek.com>
Link: https://patch.msgid.link/20260325152154.1604082-11-can.guo@oss.qualcomm.com
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
drivers/ufs/core/ufs-txeq.c
drivers/ufs/host/ufs-qcom.c
drivers/ufs/host/ufs-qcom.h
include/ufs/ufshcd.h
include/ufs/unipro.h

index 3a879c644faa50894f960ac307391dc3e610c3cd..b2dc8912435389ed00e749e310dccdb1b2ef861c 100644 (file)
@@ -232,9 +232,8 @@ ufshcd_compose_tx_eq_setting(struct ufshcd_tx_eq_settings *settings,
  *
  * Returns 0 on success, negative error code otherwise
  */
-static int ufshcd_apply_tx_eq_settings(struct ufs_hba *hba,
-                                      struct ufshcd_tx_eq_params *params,
-                                      u32 gear)
+int ufshcd_apply_tx_eq_settings(struct ufs_hba *hba,
+                               struct ufshcd_tx_eq_params *params, u32 gear)
 {
        struct ufs_pa_layer_attr *pwr_info = &hba->max_pwr_info.info;
        u32 setting;
@@ -263,6 +262,7 @@ static int ufshcd_apply_tx_eq_settings(struct ufs_hba *hba,
 
        return 0;
 }
+EXPORT_SYMBOL_GPL(ufshcd_apply_tx_eq_settings);
 
 /**
  * ufshcd_evaluate_tx_eqtr_fom - Evaluate TX EQTR FOM results
index eac5e95e740b1e5d256f52da242341939cba1b0f..a0314cb55c7f87a9c94673025c67bded704b3833 100644 (file)
@@ -2505,6 +2505,317 @@ static u32 ufs_qcom_freq_to_gear_speed(struct ufs_hba *hba, unsigned long freq)
        return min_t(u32, gear, hba->max_pwr_info.info.gear_rx);
 }
 
+static int ufs_qcom_host_eom_config(struct ufs_hba *hba, int lane,
+                                   const struct ufs_eom_coord *eom_coord,
+                                   u32 target_test_count)
+{
+       enum ufs_eom_eye_mask eye_mask = eom_coord->eye_mask;
+       int v_step = eom_coord->v_step;
+       int t_step = eom_coord->t_step;
+       u32 volt_step, timing_step;
+       int ret;
+
+       if (abs(v_step) > UFS_QCOM_EOM_VOLTAGE_STEPS_MAX) {
+               dev_err(hba->dev, "Invalid EOM Voltage Step: %d\n", v_step);
+               return -ERANGE;
+       }
+
+       if (abs(t_step) > UFS_QCOM_EOM_TIMING_STEPS_MAX) {
+               dev_err(hba->dev, "Invalid EOM Timing Step: %d\n", t_step);
+               return -ERANGE;
+       }
+
+       if (v_step < 0)
+               volt_step = RX_EYEMON_NEGATIVE_STEP_BIT | (u32)(-v_step);
+       else
+               volt_step = (u32)v_step;
+
+       if (t_step < 0)
+               timing_step = RX_EYEMON_NEGATIVE_STEP_BIT | (u32)(-t_step);
+       else
+               timing_step = (u32)t_step;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB_SEL(RX_EYEMON_ENABLE,
+                               UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                            BIT(eye_mask) | RX_EYEMON_EXTENDED_VRANGE_BIT);
+       if (ret) {
+               dev_err(hba->dev, "Failed to enable Host EOM on Lane %d: %d\n",
+                       lane, ret);
+               return ret;
+       }
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB_SEL(RX_EYEMON_TIMING_STEPS,
+                               UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                            timing_step);
+       if (ret) {
+               dev_err(hba->dev, "Failed to set Host EOM timing step on Lane %d: %d\n",
+                       lane, ret);
+               return ret;
+       }
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB_SEL(RX_EYEMON_VOLTAGE_STEPS,
+                               UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                            volt_step);
+       if (ret) {
+               dev_err(hba->dev, "Failed to set Host EOM voltage step on Lane %d: %d\n",
+                       lane, ret);
+               return ret;
+       }
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB_SEL(RX_EYEMON_TARGET_TEST_COUNT,
+                               UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                            target_test_count);
+       if (ret)
+               dev_err(hba->dev, "Failed to set Host EOM target test count on Lane %d: %d\n",
+                       lane, ret);
+
+       return ret;
+}
+
+static int ufs_qcom_host_eom_may_stop(struct ufs_hba *hba, int lane,
+                                     u32 target_test_count, u32 *err_count)
+{
+       u32 start, tested_count, error_count;
+       int ret;
+
+       ret = ufshcd_dme_get(hba, UIC_ARG_MIB_SEL(RX_EYEMON_START,
+                               UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                            &start);
+       if (ret) {
+               dev_err(hba->dev, "Failed to get Host EOM start status on Lane %d: %d\n",
+                       lane, ret);
+               return ret;
+       }
+
+       if (start & 0x1)
+               return -EAGAIN;
+
+       ret = ufshcd_dme_get(hba, UIC_ARG_MIB_SEL(RX_EYEMON_TESTED_COUNT,
+                               UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                            &tested_count);
+       if (ret) {
+               dev_err(hba->dev, "Failed to get Host EOM tested count on Lane %d: %d\n",
+                       lane, ret);
+               return ret;
+       }
+
+       ret = ufshcd_dme_get(hba, UIC_ARG_MIB_SEL(RX_EYEMON_ERROR_COUNT,
+                               UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                            &error_count);
+       if (ret) {
+               dev_err(hba->dev, "Failed to get Host EOM error count on Lane %d: %d\n",
+                       lane, ret);
+               return ret;
+       }
+
+       /* EOM can stop */
+       if ((tested_count >= target_test_count - 3) || error_count > 0) {
+               *err_count = error_count;
+
+               /* Disable EOM */
+               ret = ufshcd_dme_set(hba, UIC_ARG_MIB_SEL(RX_EYEMON_ENABLE,
+                                       UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane)),
+                                    0x0);
+               if (ret) {
+                       dev_err(hba->dev, "Failed to disable Host EOM on Lane %d: %d\n",
+                               lane, ret);
+                       return ret;
+               }
+       } else {
+               return -EAGAIN;
+       }
+
+       return 0;
+}
+
+static int ufs_qcom_host_eom_scan(struct ufs_hba *hba, int num_lanes,
+                                 const struct ufs_eom_coord *eom_coord,
+                                 u32 target_test_count, u32 *err_count)
+{
+       bool eom_stopped[PA_MAXDATALANES] = { 0 };
+       int lane, ret;
+       u32 setting;
+
+       if (!err_count || !eom_coord)
+               return -EINVAL;
+
+       if (target_test_count < UFS_QCOM_EOM_TARGET_TEST_COUNT_MIN) {
+               dev_err(hba->dev, "Target test count (%u) too small for Host EOM\n",
+                       target_test_count);
+               return -ERANGE;
+       }
+
+       for (lane = 0; lane < num_lanes; lane++) {
+               ret = ufs_qcom_host_eom_config(hba, lane, eom_coord,
+                                              target_test_count);
+               if (ret) {
+                       dev_err(hba->dev, "Failed to config Host RX EOM: %d\n", ret);
+                       return ret;
+               }
+       }
+
+       /*
+        * Trigger a PACP_PWR_req to kick start EOM, but not to really change
+        * the Power Mode.
+        */
+       ret = ufshcd_uic_change_pwr_mode(hba, FAST_MODE << 4 | FAST_MODE);
+       if (ret) {
+               dev_err(hba->dev, "Failed to change power mode to kick start Host EOM: %d\n",
+                       ret);
+               return ret;
+       }
+
+more_burst:
+       /* Create burst on Host RX Lane. */
+       ufshcd_dme_peer_get(hba, UIC_ARG_MIB(PA_LOCALVERINFO), &setting);
+
+       for (lane = 0; lane < num_lanes; lane++) {
+               if (eom_stopped[lane])
+                       continue;
+
+               ret = ufs_qcom_host_eom_may_stop(hba, lane, target_test_count,
+                                                &err_count[lane]);
+               if (!ret) {
+                       eom_stopped[lane] = true;
+               } else if (ret == -EAGAIN) {
+                       /* Need more burst to excercise EOM */
+                       goto more_burst;
+               } else {
+                       dev_err(hba->dev, "Failed to stop Host EOM: %d\n", ret);
+                       return ret;
+               }
+
+               dev_dbg(hba->dev, "Host RX Lane %d EOM, v_step %d, t_step %d, error count %u\n",
+                       lane, eom_coord->v_step, eom_coord->t_step,
+                       err_count[lane]);
+       }
+
+       return 0;
+}
+
+static int ufs_qcom_host_sw_rx_fom(struct ufs_hba *hba, int num_lanes, u32 *fom)
+{
+       const struct ufs_eom_coord *eom_coord = sw_rx_fom_eom_coords_g6;
+       u32 eom_err_count[PA_MAXDATALANES] = { 0 };
+       u32 curr_ahit;
+       int lane, i, ret;
+
+       if (!fom)
+               return -EINVAL;
+
+       /* Stop the auto hibernate idle timer */
+       curr_ahit = ufshcd_readl(hba, REG_AUTO_HIBERNATE_IDLE_TIMER);
+       if (curr_ahit)
+               ufshcd_writel(hba, 0, REG_AUTO_HIBERNATE_IDLE_TIMER);
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(PA_TXHSADAPTTYPE), PA_NO_ADAPT);
+       if (ret) {
+               dev_err(hba->dev, "Failed to select NO_ADAPT before starting Host EOM: %d\n", ret);
+               goto out;
+       }
+
+       for (i = 0; i < SW_RX_FOM_EOM_COORDS; i++, eom_coord++) {
+               ret = ufs_qcom_host_eom_scan(hba, num_lanes, eom_coord,
+                                            UFS_QCOM_EOM_TARGET_TEST_COUNT_G6,
+                                            eom_err_count);
+               if (ret) {
+                       dev_err(hba->dev, "Failed to run Host EOM scan: %d\n", ret);
+                       break;
+               }
+
+               for (lane = 0; lane < num_lanes; lane++) {
+                       /* Bad coordinates have no weights */
+                       if (eom_err_count[lane])
+                               continue;
+                       fom[lane] += SW_RX_FOM_EOM_COORDS_WEIGHT;
+               }
+       }
+
+out:
+       /* Restore the auto hibernate idle timer */
+       if (curr_ahit)
+               ufshcd_writel(hba, curr_ahit, REG_AUTO_HIBERNATE_IDLE_TIMER);
+
+       return ret;
+}
+
+static int ufs_qcom_get_rx_fom(struct ufs_hba *hba,
+                              struct ufs_pa_layer_attr *pwr_mode,
+                              struct tx_eqtr_iter *h_iter,
+                              struct tx_eqtr_iter *d_iter)
+{
+       struct ufshcd_tx_eq_params *params __free(kfree) =
+               kzalloc(sizeof(*params), GFP_KERNEL);
+       struct ufs_qcom_host *host = ufshcd_get_variant(hba);
+       struct ufs_pa_layer_attr old_pwr_info;
+       u32 fom[PA_MAXDATALANES] = { 0 };
+       u32 gear = pwr_mode->gear_tx;
+       u32 rate = pwr_mode->hs_rate;
+       int lane, ret;
+
+       if (host->hw_ver.major != 0x7 || host->hw_ver.minor > 0x1 ||
+           gear <= UFS_HS_G5 || !d_iter || !d_iter->is_updated)
+               return 0;
+
+       if (gear < UFS_HS_G1 || gear > UFS_HS_GEAR_MAX)
+               return -ERANGE;
+
+       if (!params)
+               return -ENOMEM;
+
+       memcpy(&old_pwr_info, &hba->pwr_info, sizeof(struct ufs_pa_layer_attr));
+
+       memcpy(params, &hba->tx_eq_params[gear - 1], sizeof(struct ufshcd_tx_eq_params));
+       for (lane = 0; lane < pwr_mode->lane_rx; lane++) {
+               params->device[lane].preshoot = d_iter->preshoot;
+               params->device[lane].deemphasis = d_iter->deemphasis;
+       }
+
+       /* Use TX EQTR settings as Device's TX Equalization settings. */
+       ret = ufshcd_apply_tx_eq_settings(hba, params, gear);
+       if (ret) {
+               dev_err(hba->dev, "%s: Failed to apply TX EQ settings for HS-G%u: %d\n",
+                       __func__, gear, ret);
+               return ret;
+       }
+
+       /* Force PMC to target HS Gear to use new TX Equalization settings. */
+       ret = ufshcd_change_power_mode(hba, pwr_mode, UFSHCD_PMC_POLICY_FORCE);
+       if (ret) {
+               dev_err(hba->dev, "%s: Failed to change power mode to HS-G%u, Rate-%s: %d\n",
+                       __func__, gear, ufs_hs_rate_to_str(rate), ret);
+               return ret;
+       }
+
+       ret = ufs_qcom_host_sw_rx_fom(hba, pwr_mode->lane_rx, fom);
+       if (ret) {
+               dev_err(hba->dev, "Failed to get SW FOM of TX (PreShoot: %u, DeEmphasis: %u): %d\n",
+                       d_iter->preshoot, d_iter->deemphasis, ret);
+               return ret;
+       }
+
+       /* Restore Device's TX Equalization settings. */
+       ret = ufshcd_apply_tx_eq_settings(hba, &hba->tx_eq_params[gear - 1], gear);
+       if (ret) {
+               dev_err(hba->dev, "%s: Failed to apply TX EQ settings for HS-G%u: %d\n",
+                       __func__, gear, ret);
+               return ret;
+       }
+
+       /* Restore Power Mode. */
+       ret = ufshcd_change_power_mode(hba, &old_pwr_info, UFSHCD_PMC_POLICY_FORCE);
+       if (ret) {
+               dev_err(hba->dev, "%s: Failed to retore power mode to HS-G%u: %d\n",
+                       __func__, old_pwr_info.gear_tx, ret);
+               return ret;
+       }
+
+       for (lane = 0; lane < pwr_mode->lane_rx; lane++)
+               d_iter->fom[lane] = fom[lane];
+
+       return 0;
+}
+
 static int ufs_qcom_tx_eqtr_notify(struct ufs_hba *hba,
                                   enum ufs_notify_change_status status,
                                   struct ufs_pa_layer_attr *pwr_mode)
@@ -2575,6 +2886,7 @@ static const struct ufs_hba_variant_ops ufs_hba_qcom_vops = {
        .get_outstanding_cqs    = ufs_qcom_get_outstanding_cqs,
        .config_esi             = ufs_qcom_config_esi,
        .freq_to_gear_speed     = ufs_qcom_freq_to_gear_speed,
+       .get_rx_fom             = ufs_qcom_get_rx_fom,
        .tx_eqtr_notify         = ufs_qcom_tx_eqtr_notify,
 };
 
index 1111ab34da018480a59918f6b501408ef43da643..7183d6b2c8bbc4a1477f40f4cbc7347c6659ac63 100644 (file)
 #define DL_VS_CLK_CFG_MASK GENMASK(9, 0)
 #define DME_VS_CORE_CLK_CTRL_DME_HW_CGC_EN             BIT(9)
 
+#define UFS_QCOM_EOM_VOLTAGE_STEPS_MAX         127
+#define UFS_QCOM_EOM_TIMING_STEPS_MAX          63
+#define UFS_QCOM_EOM_TARGET_TEST_COUNT_MIN     8
+#define UFS_QCOM_EOM_TARGET_TEST_COUNT_G6      0x3F
+
+#define SW_RX_FOM_EOM_COORDS           23
+#define SW_RX_FOM_EOM_COORDS_WEIGHT    (127 / SW_RX_FOM_EOM_COORDS)
+
+struct ufs_eom_coord {
+       int t_step;
+       int v_step;
+       u8 eye_mask;
+};
+
+static const struct ufs_eom_coord sw_rx_fom_eom_coords_g6[SW_RX_FOM_EOM_COORDS] = {
+       [0] = { -2, -15, UFS_EOM_EYE_MASK_M },
+       [1] = { 0, -15, UFS_EOM_EYE_MASK_M },
+       [2] = { 2, -15, UFS_EOM_EYE_MASK_M },
+       [3] = { -4, -10, UFS_EOM_EYE_MASK_M },
+       [4] = { -2, -10, UFS_EOM_EYE_MASK_M },
+       [5] = { 0, -10, UFS_EOM_EYE_MASK_M },
+       [6] = { 2, -10, UFS_EOM_EYE_MASK_M },
+       [7] = { 4, -10, UFS_EOM_EYE_MASK_M },
+       [8] = { -6, 0, UFS_EOM_EYE_MASK_M },
+       [9] = { -4, 0, UFS_EOM_EYE_MASK_M },
+       [10] = { -2, 0, UFS_EOM_EYE_MASK_M },
+       [11] = { 0, 0, UFS_EOM_EYE_MASK_M },
+       [12] = { 2, 0, UFS_EOM_EYE_MASK_M },
+       [13] = { 4, 0, UFS_EOM_EYE_MASK_M },
+       [14] = { 6, 0, UFS_EOM_EYE_MASK_M },
+       [15] = { -4, 10, UFS_EOM_EYE_MASK_M },
+       [16] = { -2, 10, UFS_EOM_EYE_MASK_M },
+       [17] = { 0, 10, UFS_EOM_EYE_MASK_M },
+       [18] = { 2, 10, UFS_EOM_EYE_MASK_M },
+       [19] = { 4, 10, UFS_EOM_EYE_MASK_M },
+       [20] = { -2, 15, UFS_EOM_EYE_MASK_M },
+       [21] = { 0, 15, UFS_EOM_EYE_MASK_M },
+       [22] = { 2, 15, UFS_EOM_EYE_MASK_M },
+};
+
 /* Qualcomm MCQ Configuration */
 #define UFS_QCOM_MCQCAP_QCFGPTR     224  /* 0xE0 in hex */
 #define UFS_QCOM_MCQ_CONFIG_OFFSET  (UFS_QCOM_MCQCAP_QCFGPTR * 0x200)  /* 0x1C000 */
index bc9e48e89db433d151aa6000ba1ad1c5aade4abe..be15b62473039e1a31643032360de915c64ef8b7 100644 (file)
@@ -1515,6 +1515,9 @@ extern int ufshcd_config_pwr_mode(struct ufs_hba *hba,
                                  struct ufs_pa_layer_attr *desired_pwr_mode,
                                  enum ufshcd_pmc_policy pmc_policy);
 extern int ufshcd_uic_change_pwr_mode(struct ufs_hba *hba, u8 mode);
+extern int ufshcd_apply_tx_eq_settings(struct ufs_hba *hba,
+                                      struct ufshcd_tx_eq_params *params,
+                                      u32 gear);
 
 /* UIC command interfaces for DME primitives */
 #define DME_LOCAL      0
index 4aa592130b4eb8511415f7c295fb06cbc3561303..f849a2a101ae295c6ece83a763e3a8dd3c838744 100644 (file)
@@ -32,6 +32,8 @@
 #define TX_LCC_SEQUENCER                       0x0032
 #define TX_MIN_ACTIVATETIME                    0x0033
 #define TX_PWM_G6_G7_SYNC_LENGTH               0x0034
+#define TX_HS_DEEMPHASIS_SETTING               0x0037
+#define TX_HS_PRESHOOT_SETTING                 0x003B
 #define TX_REFCLKFREQ                          0x00EB
 #define TX_CFGCLKFREQVAL                       0x00EC
 #define        CFGEXTRATTR                             0x00F0
 #define RX_REFCLKFREQ                          0x00EB
 #define        RX_CFGCLKFREQVAL                        0x00EC
 #define CFGWIDEINLN                            0x00F0
+#define RX_EYEMON_CAP                          0x00F1
+#define RX_EYEMON_TIMING_MAX_STEPS_CAP         0x00F2
+#define RX_EYEMON_TIMING_MAX_OFFSET_CAP                0x00F3
+#define RX_EYEMON_VOLTAGE_MAX_STEPS_CAP                0x00F4
+#define RX_EYEMON_VOLTAGE_MAX_OFFSET_CAP       0x00F5
+#define RX_EYEMON_ENABLE                       0x00F6
+#define RX_EYEMON_TIMING_STEPS                 0x00F7
+#define RX_EYEMON_VOLTAGE_STEPS                        0x00F8
+#define RX_EYEMON_TARGET_TEST_COUNT            0x00F9
+#define RX_EYEMON_TESTED_COUNT                 0x00FA
+#define RX_EYEMON_ERROR_COUNT                  0x00FB
+#define RX_EYEMON_START                                0x00FC
+#define RX_EYEMON_EXTENDED_ERROR_COUNT         0x00FD
+
 #define ENARXDIRECTCFG4                                0x00F2
 #define ENARXDIRECTCFG3                                0x00F3
 #define ENARXDIRECTCFG2                                0x00F4
 
+#define RX_EYEMON_NEGATIVE_STEP_BIT            BIT(6)
+#define RX_EYEMON_EXTENDED_VRANGE_BIT          BIT(6)
+
 #define is_mphy_tx_attr(attr)                  (attr < RX_MODE)
 #define RX_ADV_FINE_GRAN_STEP(x)               ((((x) & 0x3) << 1) | 0x1)
 #define SYNC_LEN_FINE(x)                       ((x) & 0x3F)
@@ -297,6 +316,12 @@ enum ufs_tx_hs_deemphasis {
        UFS_TX_HS_DEEMPHASIS_DB_7P6,
 };
 
+enum ufs_eom_eye_mask {
+       UFS_EOM_EYE_MASK_M,
+       UFS_EOM_EYE_MASK_L,
+       UFS_EOM_EYE_MASK_U,
+};
+
 #define DL_FC0ProtectionTimeOutVal_Default     8191
 #define DL_TC0ReplayTimeOutVal_Default         65535
 #define DL_AFC0ReqTimeOutVal_Default           32767