drivers/ufs/host/ufs-qcom.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (c) 2013-2016, Linux Foundation. All rights reserved.
   4  */
   5
   6 #include <linux/acpi.h>
   7 #include <linux/clk.h>
   8 #include <linux/delay.h>
   9 #include <linux/devfreq.h>
  10 #include <linux/gpio/consumer.h>
  11 #include <linux/interconnect.h>
  12 #include <linux/module.h>
  13 #include <linux/of.h>
  14 #include <linux/phy/phy.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/reset-controller.h>
  17 #include <linux/time.h>
  18
  19 #include <soc/qcom/ice.h>
  20
  21 #include <ufs/ufshcd.h>
  22 #include <ufs/ufshci.h>
  23 #include <ufs/ufs_quirks.h>
  24 #include <ufs/unipro.h>
  25 #include "ufshcd-pltfrm.h"
  26 #include "ufs-qcom.h"
  27
  28 #define MCQ_QCFGPTR_MASK        GENMASK(7, 0)
  29 #define MCQ_QCFGPTR_UNIT        0x200
  30 #define MCQ_SQATTR_OFFSET(c) \
  31         ((((c) >> 16) & MCQ_QCFGPTR_MASK) * MCQ_QCFGPTR_UNIT)
  32 #define MCQ_QCFG_SIZE   0x40
  33
  34 enum {
  35         TSTBUS_UAWM,
  36         TSTBUS_UARM,
  37         TSTBUS_TXUC,
  38         TSTBUS_RXUC,
  39         TSTBUS_DFC,
  40         TSTBUS_TRLUT,
  41         TSTBUS_TMRLUT,
  42         TSTBUS_OCSC,
  43         TSTBUS_UTP_HCI,
  44         TSTBUS_COMBINED,
  45         TSTBUS_WRAPPER,
  46         TSTBUS_UNIPRO,
  47         TSTBUS_MAX,
  48 };
  49
  50 #define QCOM_UFS_MAX_GEAR 4
  51 #define QCOM_UFS_MAX_LANE 2
  52
  53 enum {
  54         MODE_MIN,
  55         MODE_PWM,
  56         MODE_HS_RA,
  57         MODE_HS_RB,
  58         MODE_MAX,
  59 };
  60
  61 static const struct __ufs_qcom_bw_table {
  62         u32 mem_bw;
  63         u32 cfg_bw;
  64 } ufs_qcom_bw_table[MODE_MAX + 1][QCOM_UFS_MAX_GEAR + 1][QCOM_UFS_MAX_LANE + 1] = {
  65         [MODE_MIN][0][0]                   = { 0,               0 }, /* Bandwidth values in KB/s */
  66         [MODE_PWM][UFS_PWM_G1][UFS_LANE_1] = { 922,             1000 },
  67         [MODE_PWM][UFS_PWM_G2][UFS_LANE_1] = { 1844,            1000 },
  68         [MODE_PWM][UFS_PWM_G3][UFS_LANE_1] = { 3688,            1000 },
  69         [MODE_PWM][UFS_PWM_G4][UFS_LANE_1] = { 7376,            1000 },
  70         [MODE_PWM][UFS_PWM_G1][UFS_LANE_2] = { 1844,            1000 },
  71         [MODE_PWM][UFS_PWM_G2][UFS_LANE_2] = { 3688,            1000 },
  72         [MODE_PWM][UFS_PWM_G3][UFS_LANE_2] = { 7376,            1000 },
  73         [MODE_PWM][UFS_PWM_G4][UFS_LANE_2] = { 14752,           1000 },
  74         [MODE_HS_RA][UFS_HS_G1][UFS_LANE_1] = { 127796,         1000 },
  75         [MODE_HS_RA][UFS_HS_G2][UFS_LANE_1] = { 255591,         1000 },
  76         [MODE_HS_RA][UFS_HS_G3][UFS_LANE_1] = { 1492582,        102400 },
  77         [MODE_HS_RA][UFS_HS_G4][UFS_LANE_1] = { 2915200,        204800 },
  78         [MODE_HS_RA][UFS_HS_G1][UFS_LANE_2] = { 255591,         1000 },
  79         [MODE_HS_RA][UFS_HS_G2][UFS_LANE_2] = { 511181,         1000 },
  80         [MODE_HS_RA][UFS_HS_G3][UFS_LANE_2] = { 1492582,        204800 },
  81         [MODE_HS_RA][UFS_HS_G4][UFS_LANE_2] = { 2915200,        409600 },
  82         [MODE_HS_RB][UFS_HS_G1][UFS_LANE_1] = { 149422,         1000 },
  83         [MODE_HS_RB][UFS_HS_G2][UFS_LANE_1] = { 298189,         1000 },
  84         [MODE_HS_RB][UFS_HS_G3][UFS_LANE_1] = { 1492582,        102400 },
  85         [MODE_HS_RB][UFS_HS_G4][UFS_LANE_1] = { 2915200,        204800 },
  86         [MODE_HS_RB][UFS_HS_G1][UFS_LANE_2] = { 298189,         1000 },
  87         [MODE_HS_RB][UFS_HS_G2][UFS_LANE_2] = { 596378,         1000 },
  88         [MODE_HS_RB][UFS_HS_G3][UFS_LANE_2] = { 1492582,        204800 },
  89         [MODE_HS_RB][UFS_HS_G4][UFS_LANE_2] = { 2915200,        409600 },
  90         [MODE_MAX][0][0]                    = { 7643136,        307200 },
  91 };
  92
  93 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host);
  94 static int ufs_qcom_set_core_clk_ctrl(struct ufs_hba *hba, bool is_scale_up);
  95
  96 static struct ufs_qcom_host *rcdev_to_ufs_host(struct reset_controller_dev *rcd)
  97 {
  98         return container_of(rcd, struct ufs_qcom_host, rcdev);
  99 }
 100
 101 #ifdef CONFIG_SCSI_UFS_CRYPTO
 102
 103 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host *host)
 104 {
 105         if (host->hba->caps & UFSHCD_CAP_CRYPTO)
 106                 qcom_ice_enable(host->ice);
 107 }
 108
 109 static int ufs_qcom_ice_init(struct ufs_qcom_host *host)
 110 {
 111         struct ufs_hba *hba = host->hba;
 112         struct device *dev = hba->dev;
 113         struct qcom_ice *ice;
 114
 115         ice = of_qcom_ice_get(dev);
 116         if (ice == ERR_PTR(-EOPNOTSUPP)) {
 117                 dev_warn(dev, "Disabling inline encryption support\n");
 118                 ice = NULL;
 119         }
 120
 121         if (IS_ERR_OR_NULL(ice))
 122                 return PTR_ERR_OR_ZERO(ice);
 123
 124         host->ice = ice;
 125         hba->caps |= UFSHCD_CAP_CRYPTO;
 126
 127         return 0;
 128 }
 129
 130 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host *host)
 131 {
 132         if (host->hba->caps & UFSHCD_CAP_CRYPTO)
 133                 return qcom_ice_resume(host->ice);
 134
 135         return 0;
 136 }
 137
 138 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host *host)
 139 {
 140         if (host->hba->caps & UFSHCD_CAP_CRYPTO)
 141                 return qcom_ice_suspend(host->ice);
 142
 143         return 0;
 144 }
 145
 146 static int ufs_qcom_ice_program_key(struct ufs_hba *hba,
 147                                     const union ufs_crypto_cfg_entry *cfg,
 148                                     int slot)
 149 {
 150         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 151         union ufs_crypto_cap_entry cap;
 152         bool config_enable =
 153                 cfg->config_enable & UFS_CRYPTO_CONFIGURATION_ENABLE;
 154
 155         /* Only AES-256-XTS has been tested so far. */
 156         cap = hba->crypto_cap_array[cfg->crypto_cap_idx];
 157         if (cap.algorithm_id != UFS_CRYPTO_ALG_AES_XTS ||
 158             cap.key_size != UFS_CRYPTO_KEY_SIZE_256)
 159                 return -EOPNOTSUPP;
 160
 161         if (config_enable)
 162                 return qcom_ice_program_key(host->ice,
 163                                             QCOM_ICE_CRYPTO_ALG_AES_XTS,
 164                                             QCOM_ICE_CRYPTO_KEY_SIZE_256,
 165                                             cfg->crypto_key,
 166                                             cfg->data_unit_size, slot);
 167         else
 168                 return qcom_ice_evict_key(host->ice, slot);
 169 }
 170
 171 #else
 172
 173 #define ufs_qcom_ice_program_key NULL
 174
 175 static inline void ufs_qcom_ice_enable(struct ufs_qcom_host *host)
 176 {
 177 }
 178
 179 static int ufs_qcom_ice_init(struct ufs_qcom_host *host)
 180 {
 181         return 0;
 182 }
 183
 184 static inline int ufs_qcom_ice_resume(struct ufs_qcom_host *host)
 185 {
 186         return 0;
 187 }
 188
 189 static inline int ufs_qcom_ice_suspend(struct ufs_qcom_host *host)
 190 {
 191         return 0;
 192 }
 193 #endif
 194
 195 static void ufs_qcom_disable_lane_clks(struct ufs_qcom_host *host)
 196 {
 197         if (!host->is_lane_clks_enabled)
 198                 return;
 199
 200         clk_bulk_disable_unprepare(host->num_clks, host->clks);
 201
 202         host->is_lane_clks_enabled = false;
 203 }
 204
 205 static int ufs_qcom_enable_lane_clks(struct ufs_qcom_host *host)
 206 {
 207         int err;
 208
 209         err = clk_bulk_prepare_enable(host->num_clks, host->clks);
 210         if (err)
 211                 return err;
 212
 213         host->is_lane_clks_enabled = true;
 214
 215         return 0;
 216 }
 217
 218 static int ufs_qcom_init_lane_clks(struct ufs_qcom_host *host)
 219 {
 220         int err;
 221         struct device *dev = host->hba->dev;
 222
 223         if (has_acpi_companion(dev))
 224                 return 0;
 225
 226         err = devm_clk_bulk_get_all(dev, &host->clks);
 227         if (err <= 0)
 228                 return err;
 229
 230         host->num_clks = err;
 231
 232         return 0;
 233 }
 234
 235 static int ufs_qcom_check_hibern8(struct ufs_hba *hba)
 236 {
 237         int err;
 238         u32 tx_fsm_val;
 239         unsigned long timeout = jiffies + msecs_to_jiffies(HBRN8_POLL_TOUT_MS);
 240
 241         do {
 242                 err = ufshcd_dme_get(hba,
 243                                 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
 244                                         UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
 245                                 &tx_fsm_val);
 246                 if (err || tx_fsm_val == TX_FSM_HIBERN8)
 247                         break;
 248
 249                 /* sleep for max. 200us */
 250                 usleep_range(100, 200);
 251         } while (time_before(jiffies, timeout));
 252
 253         /*
 254          * we might have scheduled out for long during polling so
 255          * check the state again.
 256          */
 257         if (time_after(jiffies, timeout))
 258                 err = ufshcd_dme_get(hba,
 259                                 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
 260                                         UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
 261                                 &tx_fsm_val);
 262
 263         if (err) {
 264                 dev_err(hba->dev, "%s: unable to get TX_FSM_STATE, err %d\n",
 265                                 __func__, err);
 266         } else if (tx_fsm_val != TX_FSM_HIBERN8) {
 267                 err = tx_fsm_val;
 268                 dev_err(hba->dev, "%s: invalid TX_FSM_STATE = %d\n",
 269                                 __func__, err);
 270         }
 271
 272         return err;
 273 }
 274
 275 static void ufs_qcom_select_unipro_mode(struct ufs_qcom_host *host)
 276 {
 277         ufshcd_rmwl(host->hba, QUNIPRO_SEL, QUNIPRO_SEL, REG_UFS_CFG1);
 278
 279         if (host->hw_ver.major >= 0x05)
 280                 ufshcd_rmwl(host->hba, QUNIPRO_G4_SEL, 0, REG_UFS_CFG0);
 281
 282         /* make sure above configuration is applied before we return */
 283         mb();
 284 }
 285
 286 /*
 287  * ufs_qcom_host_reset - reset host controller and PHY
 288  */
 289 static int ufs_qcom_host_reset(struct ufs_hba *hba)
 290 {
 291         int ret;
 292         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 293         bool reenable_intr;
 294
 295         if (!host->core_reset)
 296                 return 0;
 297
 298         reenable_intr = hba->is_irq_enabled;
 299         ufshcd_disable_irq(hba);
 300
 301         ret = reset_control_assert(host->core_reset);
 302         if (ret) {
 303                 dev_err(hba->dev, "%s: core_reset assert failed, err = %d\n",
 304                                  __func__, ret);
 305                 return ret;
 306         }
 307
 308         /*
 309          * The hardware requirement for delay between assert/deassert
 310          * is at least 3-4 sleep clock (32.7KHz) cycles, which comes to
 311          * ~125us (4/32768). To be on the safe side add 200us delay.
 312          */
 313         usleep_range(200, 210);
 314
 315         ret = reset_control_deassert(host->core_reset);
 316         if (ret) {
 317                 dev_err(hba->dev, "%s: core_reset deassert failed, err = %d\n",
 318                                  __func__, ret);
 319                 return ret;
 320         }
 321
 322         usleep_range(1000, 1100);
 323
 324         if (reenable_intr)
 325                 ufshcd_enable_irq(hba);
 326
 327         return 0;
 328 }
 329
 330 static u32 ufs_qcom_get_hs_gear(struct ufs_hba *hba)
 331 {
 332         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 333
 334         if (host->hw_ver.major >= 0x4)
 335                 return UFS_QCOM_MAX_GEAR(ufshcd_readl(hba, REG_UFS_PARAM0));
 336
 337         /* Default is HS-G3 */
 338         return UFS_HS_G3;
 339 }
 340
 341 static int ufs_qcom_power_up_sequence(struct ufs_hba *hba)
 342 {
 343         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 344         struct ufs_host_params *host_params = &host->host_params;
 345         struct phy *phy = host->generic_phy;
 346         enum phy_mode mode;
 347         int ret;
 348
 349         /*
 350          * HW ver 5 can only support up to HS-G5 Rate-A due to HW limitations.
 351          * If the HS-G5 PHY gear is used, update host_params->hs_rate to Rate-A,
 352          * so that the subsequent power mode change shall stick to Rate-A.
 353          */
 354         if (host->hw_ver.major == 0x5) {
 355                 if (host->phy_gear == UFS_HS_G5)
 356                         host_params->hs_rate = PA_HS_MODE_A;
 357                 else
 358                         host_params->hs_rate = PA_HS_MODE_B;
 359         }
 360
 361         mode = host_params->hs_rate == PA_HS_MODE_B ? PHY_MODE_UFS_HS_B : PHY_MODE_UFS_HS_A;
 362
 363         /* Reset UFS Host Controller and PHY */
 364         ret = ufs_qcom_host_reset(hba);
 365         if (ret)
 366                 return ret;
 367
 368         /* phy initialization - calibrate the phy */
 369         ret = phy_init(phy);
 370         if (ret) {
 371                 dev_err(hba->dev, "%s: phy init failed, ret = %d\n",
 372                         __func__, ret);
 373                 return ret;
 374         }
 375
 376         ret = phy_set_mode_ext(phy, mode, host->phy_gear);
 377         if (ret)
 378                 goto out_disable_phy;
 379
 380         /* power on phy - start serdes and phy's power and clocks */
 381         ret = phy_power_on(phy);
 382         if (ret) {
 383                 dev_err(hba->dev, "%s: phy power on failed, ret = %d\n",
 384                         __func__, ret);
 385                 goto out_disable_phy;
 386         }
 387
 388         ufs_qcom_select_unipro_mode(host);
 389
 390         return 0;
 391
 392 out_disable_phy:
 393         phy_exit(phy);
 394
 395         return ret;
 396 }
 397
 398 /*
 399  * The UTP controller has a number of internal clock gating cells (CGCs).
 400  * Internal hardware sub-modules within the UTP controller control the CGCs.
 401  * Hardware CGCs disable the clock to inactivate UTP sub-modules not involved
 402  * in a specific operation, UTP controller CGCs are by default disabled and
 403  * this function enables them (after every UFS link startup) to save some power
 404  * leakage.
 405  */
 406 static void ufs_qcom_enable_hw_clk_gating(struct ufs_hba *hba)
 407 {
 408         ufshcd_rmwl(hba, REG_UFS_CFG2_CGC_EN_ALL, REG_UFS_CFG2_CGC_EN_ALL,
 409                     REG_UFS_CFG2);
 410
 411         /* Ensure that HW clock gating is enabled before next operations */
 412         mb();
 413 }
 414
 415 static int ufs_qcom_hce_enable_notify(struct ufs_hba *hba,
 416                                       enum ufs_notify_change_status status)
 417 {
 418         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 419         int err;
 420
 421         switch (status) {
 422         case PRE_CHANGE:
 423                 err = ufs_qcom_power_up_sequence(hba);
 424                 if (err)
 425                         return err;
 426
 427                 /*
 428                  * The PHY PLL output is the source of tx/rx lane symbol
 429                  * clocks, hence, enable the lane clocks only after PHY
 430                  * is initialized.
 431                  */
 432                 err = ufs_qcom_enable_lane_clks(host);
 433                 break;
 434         case POST_CHANGE:
 435                 /* check if UFS PHY moved from DISABLED to HIBERN8 */
 436                 err = ufs_qcom_check_hibern8(hba);
 437                 ufs_qcom_enable_hw_clk_gating(hba);
 438                 ufs_qcom_ice_enable(host);
 439                 break;
 440         default:
 441                 dev_err(hba->dev, "%s: invalid status %d\n", __func__, status);
 442                 err = -EINVAL;
 443                 break;
 444         }
 445         return err;
 446 }
 447
 448 /**
 449  * ufs_qcom_cfg_timers - Configure ufs qcom cfg timers
 450  *
 451  * @hba: host controller instance
 452  * @gear: Current operating gear
 453  * @hs: current power mode
 454  * @rate: current operating rate (A or B)
 455  * @update_link_startup_timer: indicate if link_start ongoing
 456  * @is_pre_scale_up: flag to check if pre scale up condition.
 457  * Return: zero for success and non-zero in case of a failure.
 458  */
 459 static int ufs_qcom_cfg_timers(struct ufs_hba *hba, u32 gear,
 460                                u32 hs, u32 rate, bool update_link_startup_timer,
 461                                bool is_pre_scale_up)
 462 {
 463         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 464         struct ufs_clk_info *clki;
 465         unsigned long core_clk_rate = 0;
 466         u32 core_clk_cycles_per_us;
 467
 468         /*
 469          * UTP controller uses SYS1CLK_1US_REG register for Interrupt
 470          * Aggregation logic.
 471          * It is mandatory to write SYS1CLK_1US_REG register on UFS host
 472          * controller V4.0.0 onwards.
 473          */
 474         if (host->hw_ver.major < 4 && !ufshcd_is_intr_aggr_allowed(hba))
 475                 return 0;
 476
 477         if (gear == 0) {
 478                 dev_err(hba->dev, "%s: invalid gear = %d\n", __func__, gear);
 479                 return -EINVAL;
 480         }
 481
 482         list_for_each_entry(clki, &hba->clk_list_head, list) {
 483                 if (!strcmp(clki->name, "core_clk")) {
 484                         if (is_pre_scale_up)
 485                                 core_clk_rate = clki->max_freq;
 486                         else
 487                                 core_clk_rate = clk_get_rate(clki->clk);
 488                         break;
 489                 }
 490
 491         }
 492
 493         /* If frequency is smaller than 1MHz, set to 1MHz */
 494         if (core_clk_rate < DEFAULT_CLK_RATE_HZ)
 495                 core_clk_rate = DEFAULT_CLK_RATE_HZ;
 496
 497         core_clk_cycles_per_us = core_clk_rate / USEC_PER_SEC;
 498         if (ufshcd_readl(hba, REG_UFS_SYS1CLK_1US) != core_clk_cycles_per_us) {
 499                 ufshcd_writel(hba, core_clk_cycles_per_us, REG_UFS_SYS1CLK_1US);
 500                 /*
 501                  * make sure above write gets applied before we return from
 502                  * this function.
 503                  */
 504                 mb();
 505         }
 506
 507         return 0;
 508 }
 509
 510 static int ufs_qcom_link_startup_notify(struct ufs_hba *hba,
 511                                         enum ufs_notify_change_status status)
 512 {
 513         int err = 0;
 514
 515         switch (status) {
 516         case PRE_CHANGE:
 517                 if (ufs_qcom_cfg_timers(hba, UFS_PWM_G1, SLOWAUTO_MODE,
 518                                         0, true, false)) {
 519                         dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
 520                                 __func__);
 521                         return -EINVAL;
 522                 }
 523
 524                 err = ufs_qcom_set_core_clk_ctrl(hba, true);
 525                 if (err)
 526                         dev_err(hba->dev, "cfg core clk ctrl failed\n");
 527                 /*
 528                  * Some UFS devices (and may be host) have issues if LCC is
 529                  * enabled. So we are setting PA_Local_TX_LCC_Enable to 0
 530                  * before link startup which will make sure that both host
 531                  * and device TX LCC are disabled once link startup is
 532                  * completed.
 533                  */
 534                 if (ufshcd_get_local_unipro_ver(hba) != UFS_UNIPRO_VER_1_41)
 535                         err = ufshcd_disable_host_tx_lcc(hba);
 536
 537                 break;
 538         default:
 539                 break;
 540         }
 541
 542         return err;
 543 }
 544
 545 static void ufs_qcom_device_reset_ctrl(struct ufs_hba *hba, bool asserted)
 546 {
 547         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 548
 549         /* reset gpio is optional */
 550         if (!host->device_reset)
 551                 return;
 552
 553         gpiod_set_value_cansleep(host->device_reset, asserted);
 554 }
 555
 556 static int ufs_qcom_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op,
 557         enum ufs_notify_change_status status)
 558 {
 559         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 560         struct phy *phy = host->generic_phy;
 561
 562         if (status == PRE_CHANGE)
 563                 return 0;
 564
 565         if (ufs_qcom_is_link_off(hba)) {
 566                 /*
 567                  * Disable the tx/rx lane symbol clocks before PHY is
 568                  * powered down as the PLL source should be disabled
 569                  * after downstream clocks are disabled.
 570                  */
 571                 ufs_qcom_disable_lane_clks(host);
 572                 phy_power_off(phy);
 573
 574                 /* reset the connected UFS device during power down */
 575                 ufs_qcom_device_reset_ctrl(hba, true);
 576
 577         } else if (!ufs_qcom_is_link_active(hba)) {
 578                 ufs_qcom_disable_lane_clks(host);
 579         }
 580
 581         return ufs_qcom_ice_suspend(host);
 582 }
 583
 584 static int ufs_qcom_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
 585 {
 586         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 587         struct phy *phy = host->generic_phy;
 588         int err;
 589
 590         if (ufs_qcom_is_link_off(hba)) {
 591                 err = phy_power_on(phy);
 592                 if (err) {
 593                         dev_err(hba->dev, "%s: failed PHY power on: %d\n",
 594                                 __func__, err);
 595                         return err;
 596                 }
 597
 598                 err = ufs_qcom_enable_lane_clks(host);
 599                 if (err)
 600                         return err;
 601
 602         } else if (!ufs_qcom_is_link_active(hba)) {
 603                 err = ufs_qcom_enable_lane_clks(host);
 604                 if (err)
 605                         return err;
 606         }
 607
 608         return ufs_qcom_ice_resume(host);
 609 }
 610
 611 static void ufs_qcom_dev_ref_clk_ctrl(struct ufs_qcom_host *host, bool enable)
 612 {
 613         if (host->dev_ref_clk_ctrl_mmio &&
 614             (enable ^ host->is_dev_ref_clk_enabled)) {
 615                 u32 temp = readl_relaxed(host->dev_ref_clk_ctrl_mmio);
 616
 617                 if (enable)
 618                         temp |= host->dev_ref_clk_en_mask;
 619                 else
 620                         temp &= ~host->dev_ref_clk_en_mask;
 621
 622                 /*
 623                  * If we are here to disable this clock it might be immediately
 624                  * after entering into hibern8 in which case we need to make
 625                  * sure that device ref_clk is active for specific time after
 626                  * hibern8 enter.
 627                  */
 628                 if (!enable) {
 629                         unsigned long gating_wait;
 630
 631                         gating_wait = host->hba->dev_info.clk_gating_wait_us;
 632                         if (!gating_wait) {
 633                                 udelay(1);
 634                         } else {
 635                                 /*
 636                                  * bRefClkGatingWaitTime defines the minimum
 637                                  * time for which the reference clock is
 638                                  * required by device during transition from
 639                                  * HS-MODE to LS-MODE or HIBERN8 state. Give it
 640                                  * more delay to be on the safe side.
 641                                  */
 642                                 gating_wait += 10;
 643                                 usleep_range(gating_wait, gating_wait + 10);
 644                         }
 645                 }
 646
 647                 writel_relaxed(temp, host->dev_ref_clk_ctrl_mmio);
 648
 649                 /*
 650                  * Make sure the write to ref_clk reaches the destination and
 651                  * not stored in a Write Buffer (WB).
 652                  */
 653                 readl(host->dev_ref_clk_ctrl_mmio);
 654
 655                 /*
 656                  * If we call hibern8 exit after this, we need to make sure that
 657                  * device ref_clk is stable for at least 1us before the hibern8
 658                  * exit command.
 659                  */
 660                 if (enable)
 661                         udelay(1);
 662
 663                 host->is_dev_ref_clk_enabled = enable;
 664         }
 665 }
 666
 667 static int ufs_qcom_icc_set_bw(struct ufs_qcom_host *host, u32 mem_bw, u32 cfg_bw)
 668 {
 669         struct device *dev = host->hba->dev;
 670         int ret;
 671
 672         ret = icc_set_bw(host->icc_ddr, 0, mem_bw);
 673         if (ret < 0) {
 674                 dev_err(dev, "failed to set bandwidth request: %d\n", ret);
 675                 return ret;
 676         }
 677
 678         ret = icc_set_bw(host->icc_cpu, 0, cfg_bw);
 679         if (ret < 0) {
 680                 dev_err(dev, "failed to set bandwidth request: %d\n", ret);
 681                 return ret;
 682         }
 683
 684         return 0;
 685 }
 686
 687 static struct __ufs_qcom_bw_table ufs_qcom_get_bw_table(struct ufs_qcom_host *host)
 688 {
 689         struct ufs_pa_layer_attr *p = &host->dev_req_params;
 690         int gear = max_t(u32, p->gear_rx, p->gear_tx);
 691         int lane = max_t(u32, p->lane_rx, p->lane_tx);
 692
 693         if (ufshcd_is_hs_mode(p)) {
 694                 if (p->hs_rate == PA_HS_MODE_B)
 695                         return ufs_qcom_bw_table[MODE_HS_RB][gear][lane];
 696                 else
 697                         return ufs_qcom_bw_table[MODE_HS_RA][gear][lane];
 698         } else {
 699                 return ufs_qcom_bw_table[MODE_PWM][gear][lane];
 700         }
 701 }
 702
 703 static int ufs_qcom_icc_update_bw(struct ufs_qcom_host *host)
 704 {
 705         struct __ufs_qcom_bw_table bw_table;
 706
 707         bw_table = ufs_qcom_get_bw_table(host);
 708
 709         return ufs_qcom_icc_set_bw(host, bw_table.mem_bw, bw_table.cfg_bw);
 710 }
 711
 712 static int ufs_qcom_pwr_change_notify(struct ufs_hba *hba,
 713                                 enum ufs_notify_change_status status,
 714                                 struct ufs_pa_layer_attr *dev_max_params,
 715                                 struct ufs_pa_layer_attr *dev_req_params)
 716 {
 717         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 718         struct ufs_host_params *host_params = &host->host_params;
 719         int ret = 0;
 720
 721         if (!dev_req_params) {
 722                 pr_err("%s: incoming dev_req_params is NULL\n", __func__);
 723                 return -EINVAL;
 724         }
 725
 726         switch (status) {
 727         case PRE_CHANGE:
 728                 ret = ufshcd_negotiate_pwr_params(host_params, dev_max_params, dev_req_params);
 729                 if (ret) {
 730                         dev_err(hba->dev, "%s: failed to determine capabilities\n",
 731                                         __func__);
 732                         return ret;
 733                 }
 734
 735                 /*
 736                  * During UFS driver probe, always update the PHY gear to match the negotiated
 737                  * gear, so that, if quirk UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH is enabled,
 738                  * the second init can program the optimal PHY settings. This allows one to start
 739                  * the first init with either the minimum or the maximum support gear.
 740                  */
 741                 if (hba->ufshcd_state == UFSHCD_STATE_RESET) {
 742                         /*
 743                          * Skip REINIT if the negotiated gear matches with the
 744                          * initial phy_gear. Otherwise, update the phy_gear to
 745                          * program the optimal gear setting during REINIT.
 746                          */
 747                         if (host->phy_gear == dev_req_params->gear_tx)
 748                                 hba->quirks &= ~UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH;
 749                         else
 750                                 host->phy_gear = dev_req_params->gear_tx;
 751                 }
 752
 753                 /* enable the device ref clock before changing to HS mode */
 754                 if (!ufshcd_is_hs_mode(&hba->pwr_info) &&
 755                         ufshcd_is_hs_mode(dev_req_params))
 756                         ufs_qcom_dev_ref_clk_ctrl(host, true);
 757
 758                 if (host->hw_ver.major >= 0x4) {
 759                         ufshcd_dme_configure_adapt(hba,
 760                                                 dev_req_params->gear_tx,
 761                                                 PA_INITIAL_ADAPT);
 762                 }
 763                 break;
 764         case POST_CHANGE:
 765                 if (ufs_qcom_cfg_timers(hba, dev_req_params->gear_rx,
 766                                         dev_req_params->pwr_rx,
 767                                         dev_req_params->hs_rate, false, false)) {
 768                         dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
 769                                 __func__);
 770                         /*
 771                          * we return error code at the end of the routine,
 772                          * but continue to configure UFS_PHY_TX_LANE_ENABLE
 773                          * and bus voting as usual
 774                          */
 775                         ret = -EINVAL;
 776                 }
 777
 778                 /* cache the power mode parameters to use internally */
 779                 memcpy(&host->dev_req_params,
 780                                 dev_req_params, sizeof(*dev_req_params));
 781
 782                 ufs_qcom_icc_update_bw(host);
 783
 784                 /* disable the device ref clock if entered PWM mode */
 785                 if (ufshcd_is_hs_mode(&hba->pwr_info) &&
 786                         !ufshcd_is_hs_mode(dev_req_params))
 787                         ufs_qcom_dev_ref_clk_ctrl(host, false);
 788                 break;
 789         default:
 790                 ret = -EINVAL;
 791                 break;
 792         }
 793
 794         return ret;
 795 }
 796
 797 static int ufs_qcom_quirk_host_pa_saveconfigtime(struct ufs_hba *hba)
 798 {
 799         int err;
 800         u32 pa_vs_config_reg1;
 801
 802         err = ufshcd_dme_get(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
 803                              &pa_vs_config_reg1);
 804         if (err)
 805                 return err;
 806
 807         /* Allow extension of MSB bits of PA_SaveConfigTime attribute */
 808         return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
 809                             (pa_vs_config_reg1 | (1 << 12)));
 810 }
 811
 812 static int ufs_qcom_apply_dev_quirks(struct ufs_hba *hba)
 813 {
 814         int err = 0;
 815
 816         if (hba->dev_quirks & UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME)
 817                 err = ufs_qcom_quirk_host_pa_saveconfigtime(hba);
 818
 819         if (hba->dev_info.wmanufacturerid == UFS_VENDOR_WDC)
 820                 hba->dev_quirks |= UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE;
 821
 822         return err;
 823 }
 824
 825 static u32 ufs_qcom_get_ufs_hci_version(struct ufs_hba *hba)
 826 {
 827         return ufshci_version(2, 0);
 828 }
 829
 830 /**
 831  * ufs_qcom_advertise_quirks - advertise the known QCOM UFS controller quirks
 832  * @hba: host controller instance
 833  *
 834  * QCOM UFS host controller might have some non standard behaviours (quirks)
 835  * than what is specified by UFSHCI specification. Advertise all such
 836  * quirks to standard UFS host controller driver so standard takes them into
 837  * account.
 838  */
 839 static void ufs_qcom_advertise_quirks(struct ufs_hba *hba)
 840 {
 841         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 842
 843         if (host->hw_ver.major == 0x2)
 844                 hba->quirks |= UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION;
 845
 846         if (host->hw_ver.major > 0x3)
 847                 hba->quirks |= UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH;
 848 }
 849
 850 static void ufs_qcom_set_phy_gear(struct ufs_qcom_host *host)
 851 {
 852         struct ufs_host_params *host_params = &host->host_params;
 853         u32 val, dev_major;
 854
 855         host->phy_gear = host_params->hs_tx_gear;
 856
 857         if (host->hw_ver.major < 0x4) {
 858                 /*
 859                  * For controllers whose major HW version is < 4, power up the
 860                  * PHY using minimum supported gear (UFS_HS_G2). Switching to
 861                  * max gear will be performed during reinit if supported.
 862                  * For newer controllers, whose major HW version is >= 4, power
 863                  * up the PHY using max supported gear.
 864                  */
 865                 host->phy_gear = UFS_HS_G2;
 866         } else if (host->hw_ver.major >= 0x5) {
 867                 val = ufshcd_readl(host->hba, REG_UFS_DEBUG_SPARE_CFG);
 868                 dev_major = FIELD_GET(UFS_DEV_VER_MAJOR_MASK, val);
 869
 870                 /*
 871                  * Since the UFS device version is populated, let's remove the
 872                  * REINIT quirk as the negotiated gear won't change during boot.
 873                  * So there is no need to do reinit.
 874                  */
 875                 if (dev_major != 0x0)
 876                         host->hba->quirks &= ~UFSHCD_QUIRK_REINIT_AFTER_MAX_GEAR_SWITCH;
 877
 878                 /*
 879                  * For UFS 3.1 device and older, power up the PHY using HS-G4
 880                  * PHY gear to save power.
 881                  */
 882                 if (dev_major > 0x0 && dev_major < 0x4)
 883                         host->phy_gear = UFS_HS_G4;
 884         }
 885 }
 886
 887 static void ufs_qcom_set_host_params(struct ufs_hba *hba)
 888 {
 889         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 890         struct ufs_host_params *host_params = &host->host_params;
 891
 892         ufshcd_init_host_params(host_params);
 893
 894         /* This driver only supports symmetic gear setting i.e., hs_tx_gear == hs_rx_gear */
 895         host_params->hs_tx_gear = host_params->hs_rx_gear = ufs_qcom_get_hs_gear(hba);
 896 }
 897
 898 static void ufs_qcom_set_caps(struct ufs_hba *hba)
 899 {
 900         hba->caps |= UFSHCD_CAP_CLK_GATING | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
 901         hba->caps |= UFSHCD_CAP_CLK_SCALING | UFSHCD_CAP_WB_WITH_CLK_SCALING;
 902         hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
 903         hba->caps |= UFSHCD_CAP_WB_EN;
 904         hba->caps |= UFSHCD_CAP_AGGR_POWER_COLLAPSE;
 905         hba->caps |= UFSHCD_CAP_RPM_AUTOSUSPEND;
 906 }
 907
 908 /**
 909  * ufs_qcom_setup_clocks - enables/disable clocks
 910  * @hba: host controller instance
 911  * @on: If true, enable clocks else disable them.
 912  * @status: PRE_CHANGE or POST_CHANGE notify
 913  *
 914  * Return: 0 on success, non-zero on failure.
 915  */
 916 static int ufs_qcom_setup_clocks(struct ufs_hba *hba, bool on,
 917                                  enum ufs_notify_change_status status)
 918 {
 919         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 920
 921         /*
 922          * In case ufs_qcom_init() is not yet done, simply ignore.
 923          * This ufs_qcom_setup_clocks() shall be called from
 924          * ufs_qcom_init() after init is done.
 925          */
 926         if (!host)
 927                 return 0;
 928
 929         switch (status) {
 930         case PRE_CHANGE:
 931                 if (on) {
 932                         ufs_qcom_icc_update_bw(host);
 933                 } else {
 934                         if (!ufs_qcom_is_link_active(hba)) {
 935                                 /* disable device ref_clk */
 936                                 ufs_qcom_dev_ref_clk_ctrl(host, false);
 937                         }
 938                 }
 939                 break;
 940         case POST_CHANGE:
 941                 if (on) {
 942                         /* enable the device ref clock for HS mode*/
 943                         if (ufshcd_is_hs_mode(&hba->pwr_info))
 944                                 ufs_qcom_dev_ref_clk_ctrl(host, true);
 945                 } else {
 946                         ufs_qcom_icc_set_bw(host, ufs_qcom_bw_table[MODE_MIN][0][0].mem_bw,
 947                                             ufs_qcom_bw_table[MODE_MIN][0][0].cfg_bw);
 948                 }
 949                 break;
 950         }
 951
 952         return 0;
 953 }
 954
 955 static int
 956 ufs_qcom_reset_assert(struct reset_controller_dev *rcdev, unsigned long id)
 957 {
 958         struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
 959
 960         ufs_qcom_assert_reset(host->hba);
 961         /* provide 1ms delay to let the reset pulse propagate. */
 962         usleep_range(1000, 1100);
 963         return 0;
 964 }
 965
 966 static int
 967 ufs_qcom_reset_deassert(struct reset_controller_dev *rcdev, unsigned long id)
 968 {
 969         struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
 970
 971         ufs_qcom_deassert_reset(host->hba);
 972
 973         /*
 974          * after reset deassertion, phy will need all ref clocks,
 975          * voltage, current to settle down before starting serdes.
 976          */
 977         usleep_range(1000, 1100);
 978         return 0;
 979 }
 980
 981 static const struct reset_control_ops ufs_qcom_reset_ops = {
 982         .assert = ufs_qcom_reset_assert,
 983         .deassert = ufs_qcom_reset_deassert,
 984 };
 985
 986 static int ufs_qcom_icc_init(struct ufs_qcom_host *host)
 987 {
 988         struct device *dev = host->hba->dev;
 989         int ret;
 990
 991         host->icc_ddr = devm_of_icc_get(dev, "ufs-ddr");
 992         if (IS_ERR(host->icc_ddr))
 993                 return dev_err_probe(dev, PTR_ERR(host->icc_ddr),
 994                                     "failed to acquire interconnect path\n");
 995
 996         host->icc_cpu = devm_of_icc_get(dev, "cpu-ufs");
 997         if (IS_ERR(host->icc_cpu))
 998                 return dev_err_probe(dev, PTR_ERR(host->icc_cpu),
 999                                     "failed to acquire interconnect path\n");
1000
1001         /*
1002          * Set Maximum bandwidth vote before initializing the UFS controller and
1003          * device. Ideally, a minimal interconnect vote would suffice for the
1004          * initialization, but a max vote would allow faster initialization.
1005          */
1006         ret = ufs_qcom_icc_set_bw(host, ufs_qcom_bw_table[MODE_MAX][0][0].mem_bw,
1007                                   ufs_qcom_bw_table[MODE_MAX][0][0].cfg_bw);
1008         if (ret < 0)
1009                 return dev_err_probe(dev, ret, "failed to set bandwidth request\n");
1010
1011         return 0;
1012 }
1013
1014 /**
1015  * ufs_qcom_init - bind phy with controller
1016  * @hba: host controller instance
1017  *
1018  * Binds PHY with controller and powers up PHY enabling clocks
1019  * and regulators.
1020  *
1021  * Return: -EPROBE_DEFER if binding fails, returns negative error
1022  * on phy power up failure and returns zero on success.
1023  */
1024 static int ufs_qcom_init(struct ufs_hba *hba)
1025 {
1026         int err;
1027         struct device *dev = hba->dev;
1028         struct ufs_qcom_host *host;
1029         struct ufs_clk_info *clki;
1030
1031         host = devm_kzalloc(dev, sizeof(*host), GFP_KERNEL);
1032         if (!host)
1033                 return -ENOMEM;
1034
1035         /* Make a two way bind between the qcom host and the hba */
1036         host->hba = hba;
1037         ufshcd_set_variant(hba, host);
1038
1039         /* Setup the optional reset control of HCI */
1040         host->core_reset = devm_reset_control_get_optional(hba->dev, "rst");
1041         if (IS_ERR(host->core_reset)) {
1042                 err = dev_err_probe(dev, PTR_ERR(host->core_reset),
1043                                     "Failed to get reset control\n");
1044                 goto out_variant_clear;
1045         }
1046
1047         /* Fire up the reset controller. Failure here is non-fatal. */
1048         host->rcdev.of_node = dev->of_node;
1049         host->rcdev.ops = &ufs_qcom_reset_ops;
1050         host->rcdev.owner = dev->driver->owner;
1051         host->rcdev.nr_resets = 1;
1052         err = devm_reset_controller_register(dev, &host->rcdev);
1053         if (err)
1054                 dev_warn(dev, "Failed to register reset controller\n");
1055
1056         if (!has_acpi_companion(dev)) {
1057                 host->generic_phy = devm_phy_get(dev, "ufsphy");
1058                 if (IS_ERR(host->generic_phy)) {
1059                         err = dev_err_probe(dev, PTR_ERR(host->generic_phy), "Failed to get PHY\n");
1060                         goto out_variant_clear;
1061                 }
1062         }
1063
1064         err = ufs_qcom_icc_init(host);
1065         if (err)
1066                 goto out_variant_clear;
1067
1068         host->device_reset = devm_gpiod_get_optional(dev, "reset",
1069                                                      GPIOD_OUT_HIGH);
1070         if (IS_ERR(host->device_reset)) {
1071                 err = dev_err_probe(dev, PTR_ERR(host->device_reset),
1072                                     "Failed to acquire device reset gpio\n");
1073                 goto out_variant_clear;
1074         }
1075
1076         ufs_qcom_get_controller_revision(hba, &host->hw_ver.major,
1077                 &host->hw_ver.minor, &host->hw_ver.step);
1078
1079         host->dev_ref_clk_ctrl_mmio = hba->mmio_base + REG_UFS_CFG1;
1080         host->dev_ref_clk_en_mask = BIT(26);
1081
1082         list_for_each_entry(clki, &hba->clk_list_head, list) {
1083                 if (!strcmp(clki->name, "core_clk_unipro"))
1084                         clki->keep_link_active = true;
1085         }
1086
1087         err = ufs_qcom_init_lane_clks(host);
1088         if (err)
1089                 goto out_variant_clear;
1090
1091         ufs_qcom_set_caps(hba);
1092         ufs_qcom_advertise_quirks(hba);
1093         ufs_qcom_set_host_params(hba);
1094         ufs_qcom_set_phy_gear(host);
1095
1096         err = ufs_qcom_ice_init(host);
1097         if (err)
1098                 goto out_variant_clear;
1099
1100         ufs_qcom_setup_clocks(hba, true, POST_CHANGE);
1101
1102         ufs_qcom_get_default_testbus_cfg(host);
1103         err = ufs_qcom_testbus_config(host);
1104         if (err)
1105                 /* Failure is non-fatal */
1106                 dev_warn(dev, "%s: failed to configure the testbus %d\n",
1107                                 __func__, err);
1108
1109         return 0;
1110
1111 out_variant_clear:
1112         ufshcd_set_variant(hba, NULL);
1113
1114         return err;
1115 }
1116
1117 static void ufs_qcom_exit(struct ufs_hba *hba)
1118 {
1119         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1120
1121         ufs_qcom_disable_lane_clks(host);
1122         phy_power_off(host->generic_phy);
1123         phy_exit(host->generic_phy);
1124 }
1125
1126 /**
1127  * ufs_qcom_set_clk_40ns_cycles - Configure 40ns clk cycles
1128  *
1129  * @hba: host controller instance
1130  * @cycles_in_1us: No of cycles in 1us to be configured
1131  *
1132  * Returns error if dme get/set configuration for 40ns fails
1133  * and returns zero on success.
1134  */
1135 static int ufs_qcom_set_clk_40ns_cycles(struct ufs_hba *hba,
1136                                         u32 cycles_in_1us)
1137 {
1138         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1139         u32 cycles_in_40ns;
1140         u32 reg;
1141         int err;
1142
1143         /*
1144          * UFS host controller V4.0.0 onwards needs to program
1145          * PA_VS_CORE_CLK_40NS_CYCLES attribute per programmed
1146          * frequency of unipro core clk of UFS host controller.
1147          */
1148         if (host->hw_ver.major < 4)
1149                 return 0;
1150
1151         /*
1152          * Generic formulae for cycles_in_40ns = (freq_unipro/25) is not
1153          * applicable for all frequencies. For ex: ceil(37.5 MHz/25) will
1154          * be 2 and ceil(403 MHZ/25) will be 17 whereas Hardware
1155          * specification expect to be 16. Hence use exact hardware spec
1156          * mandated value for cycles_in_40ns instead of calculating using
1157          * generic formulae.
1158          */
1159         switch (cycles_in_1us) {
1160         case UNIPRO_CORE_CLK_FREQ_403_MHZ:
1161                 cycles_in_40ns = 16;
1162                 break;
1163         case UNIPRO_CORE_CLK_FREQ_300_MHZ:
1164                 cycles_in_40ns = 12;
1165                 break;
1166         case UNIPRO_CORE_CLK_FREQ_201_5_MHZ:
1167                 cycles_in_40ns = 8;
1168                 break;
1169         case UNIPRO_CORE_CLK_FREQ_150_MHZ:
1170                 cycles_in_40ns = 6;
1171                 break;
1172         case UNIPRO_CORE_CLK_FREQ_100_MHZ:
1173                 cycles_in_40ns = 4;
1174                 break;
1175         case  UNIPRO_CORE_CLK_FREQ_75_MHZ:
1176                 cycles_in_40ns = 3;
1177                 break;
1178         case UNIPRO_CORE_CLK_FREQ_37_5_MHZ:
1179                 cycles_in_40ns = 2;
1180                 break;
1181         default:
1182                 dev_err(hba->dev, "UNIPRO clk freq %u MHz not supported\n",
1183                                 cycles_in_1us);
1184                 return -EINVAL;
1185         }
1186
1187         err = ufshcd_dme_get(hba, UIC_ARG_MIB(PA_VS_CORE_CLK_40NS_CYCLES), &reg);
1188         if (err)
1189                 return err;
1190
1191         reg &= ~PA_VS_CORE_CLK_40NS_CYCLES_MASK;
1192         reg |= cycles_in_40ns;
1193
1194         return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_VS_CORE_CLK_40NS_CYCLES), reg);
1195 }
1196
1197 static int ufs_qcom_set_core_clk_ctrl(struct ufs_hba *hba, bool is_scale_up)
1198 {
1199         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1200         struct list_head *head = &hba->clk_list_head;
1201         struct ufs_clk_info *clki;
1202         u32 cycles_in_1us = 0;
1203         u32 core_clk_ctrl_reg;
1204         int err;
1205
1206         list_for_each_entry(clki, head, list) {
1207                 if (!IS_ERR_OR_NULL(clki->clk) &&
1208                     !strcmp(clki->name, "core_clk_unipro")) {
1209                         if (!clki->max_freq)
1210                                 cycles_in_1us = 150; /* default for backwards compatibility */
1211                         else if (is_scale_up)
1212                                 cycles_in_1us = ceil(clki->max_freq, (1000 * 1000));
1213                         else
1214                                 cycles_in_1us = ceil(clk_get_rate(clki->clk), (1000 * 1000));
1215                         break;
1216                 }
1217         }
1218
1219         err = ufshcd_dme_get(hba,
1220                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1221                             &core_clk_ctrl_reg);
1222         if (err)
1223                 return err;
1224
1225         /* Bit mask is different for UFS host controller V4.0.0 onwards */
1226         if (host->hw_ver.major >= 4) {
1227                 if (!FIELD_FIT(CLK_1US_CYCLES_MASK_V4, cycles_in_1us))
1228                         return -ERANGE;
1229                 core_clk_ctrl_reg &= ~CLK_1US_CYCLES_MASK_V4;
1230                 core_clk_ctrl_reg |= FIELD_PREP(CLK_1US_CYCLES_MASK_V4, cycles_in_1us);
1231         } else {
1232                 if (!FIELD_FIT(CLK_1US_CYCLES_MASK, cycles_in_1us))
1233                         return -ERANGE;
1234                 core_clk_ctrl_reg &= ~CLK_1US_CYCLES_MASK;
1235                 core_clk_ctrl_reg |= FIELD_PREP(CLK_1US_CYCLES_MASK, cycles_in_1us);
1236         }
1237
1238         /* Clear CORE_CLK_DIV_EN */
1239         core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1240
1241         err = ufshcd_dme_set(hba,
1242                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1243                             core_clk_ctrl_reg);
1244         if (err)
1245                 return err;
1246
1247         /* Configure unipro core clk 40ns attribute */
1248         return ufs_qcom_set_clk_40ns_cycles(hba, cycles_in_1us);
1249 }
1250
1251 static int ufs_qcom_clk_scale_up_pre_change(struct ufs_hba *hba)
1252 {
1253         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1254         struct ufs_pa_layer_attr *attr = &host->dev_req_params;
1255         int ret;
1256
1257         ret = ufs_qcom_cfg_timers(hba, attr->gear_rx, attr->pwr_rx,
1258                                   attr->hs_rate, false, true);
1259         if (ret) {
1260                 dev_err(hba->dev, "%s ufs cfg timer failed\n", __func__);
1261                 return ret;
1262         }
1263         /* set unipro core clock attributes and clear clock divider */
1264         return ufs_qcom_set_core_clk_ctrl(hba, true);
1265 }
1266
1267 static int ufs_qcom_clk_scale_up_post_change(struct ufs_hba *hba)
1268 {
1269         return 0;
1270 }
1271
1272 static int ufs_qcom_clk_scale_down_pre_change(struct ufs_hba *hba)
1273 {
1274         int err;
1275         u32 core_clk_ctrl_reg;
1276
1277         err = ufshcd_dme_get(hba,
1278                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1279                             &core_clk_ctrl_reg);
1280
1281         /* make sure CORE_CLK_DIV_EN is cleared */
1282         if (!err &&
1283             (core_clk_ctrl_reg & DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT)) {
1284                 core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1285                 err = ufshcd_dme_set(hba,
1286                                     UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1287                                     core_clk_ctrl_reg);
1288         }
1289
1290         return err;
1291 }
1292
1293 static int ufs_qcom_clk_scale_down_post_change(struct ufs_hba *hba)
1294 {
1295         /* set unipro core clock attributes and clear clock divider */
1296         return ufs_qcom_set_core_clk_ctrl(hba, false);
1297 }
1298
1299 static int ufs_qcom_clk_scale_notify(struct ufs_hba *hba,
1300                 bool scale_up, enum ufs_notify_change_status status)
1301 {
1302         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1303         int err;
1304
1305         /* check the host controller state before sending hibern8 cmd */
1306         if (!ufshcd_is_hba_active(hba))
1307                 return 0;
1308
1309         if (status == PRE_CHANGE) {
1310                 err = ufshcd_uic_hibern8_enter(hba);
1311                 if (err)
1312                         return err;
1313                 if (scale_up)
1314                         err = ufs_qcom_clk_scale_up_pre_change(hba);
1315                 else
1316                         err = ufs_qcom_clk_scale_down_pre_change(hba);
1317
1318                 if (err) {
1319                         ufshcd_uic_hibern8_exit(hba);
1320                         return err;
1321                 }
1322         } else {
1323                 if (scale_up)
1324                         err = ufs_qcom_clk_scale_up_post_change(hba);
1325                 else
1326                         err = ufs_qcom_clk_scale_down_post_change(hba);
1327
1328
1329                 if (err) {
1330                         ufshcd_uic_hibern8_exit(hba);
1331                         return err;
1332                 }
1333
1334                 ufs_qcom_icc_update_bw(host);
1335                 ufshcd_uic_hibern8_exit(hba);
1336         }
1337
1338         return 0;
1339 }
1340
1341 static void ufs_qcom_enable_test_bus(struct ufs_qcom_host *host)
1342 {
1343         ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN,
1344                         UFS_REG_TEST_BUS_EN, REG_UFS_CFG1);
1345         ufshcd_rmwl(host->hba, TEST_BUS_EN, TEST_BUS_EN, REG_UFS_CFG1);
1346 }
1347
1348 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host)
1349 {
1350         /* provide a legal default configuration */
1351         host->testbus.select_major = TSTBUS_UNIPRO;
1352         host->testbus.select_minor = 37;
1353 }
1354
1355 static bool ufs_qcom_testbus_cfg_is_ok(struct ufs_qcom_host *host)
1356 {
1357         if (host->testbus.select_major >= TSTBUS_MAX) {
1358                 dev_err(host->hba->dev,
1359                         "%s: UFS_CFG1[TEST_BUS_SEL} may not equal 0x%05X\n",
1360                         __func__, host->testbus.select_major);
1361                 return false;
1362         }
1363
1364         return true;
1365 }
1366
1367 int ufs_qcom_testbus_config(struct ufs_qcom_host *host)
1368 {
1369         int reg;
1370         int offset;
1371         u32 mask = TEST_BUS_SUB_SEL_MASK;
1372
1373         if (!host)
1374                 return -EINVAL;
1375
1376         if (!ufs_qcom_testbus_cfg_is_ok(host))
1377                 return -EPERM;
1378
1379         switch (host->testbus.select_major) {
1380         case TSTBUS_UAWM:
1381                 reg = UFS_TEST_BUS_CTRL_0;
1382                 offset = 24;
1383                 break;
1384         case TSTBUS_UARM:
1385                 reg = UFS_TEST_BUS_CTRL_0;
1386                 offset = 16;
1387                 break;
1388         case TSTBUS_TXUC:
1389                 reg = UFS_TEST_BUS_CTRL_0;
1390                 offset = 8;
1391                 break;
1392         case TSTBUS_RXUC:
1393                 reg = UFS_TEST_BUS_CTRL_0;
1394                 offset = 0;
1395                 break;
1396         case TSTBUS_DFC:
1397                 reg = UFS_TEST_BUS_CTRL_1;
1398                 offset = 24;
1399                 break;
1400         case TSTBUS_TRLUT:
1401                 reg = UFS_TEST_BUS_CTRL_1;
1402                 offset = 16;
1403                 break;
1404         case TSTBUS_TMRLUT:
1405                 reg = UFS_TEST_BUS_CTRL_1;
1406                 offset = 8;
1407                 break;
1408         case TSTBUS_OCSC:
1409                 reg = UFS_TEST_BUS_CTRL_1;
1410                 offset = 0;
1411                 break;
1412         case TSTBUS_WRAPPER:
1413                 reg = UFS_TEST_BUS_CTRL_2;
1414                 offset = 16;
1415                 break;
1416         case TSTBUS_COMBINED:
1417                 reg = UFS_TEST_BUS_CTRL_2;
1418                 offset = 8;
1419                 break;
1420         case TSTBUS_UTP_HCI:
1421                 reg = UFS_TEST_BUS_CTRL_2;
1422                 offset = 0;
1423                 break;
1424         case TSTBUS_UNIPRO:
1425                 reg = UFS_UNIPRO_CFG;
1426                 offset = 20;
1427                 mask = 0xFFF;
1428                 break;
1429         /*
1430          * No need for a default case, since
1431          * ufs_qcom_testbus_cfg_is_ok() checks that the configuration
1432          * is legal
1433          */
1434         }
1435         mask <<= offset;
1436         ufshcd_rmwl(host->hba, TEST_BUS_SEL,
1437                     (u32)host->testbus.select_major << 19,
1438                     REG_UFS_CFG1);
1439         ufshcd_rmwl(host->hba, mask,
1440                     (u32)host->testbus.select_minor << offset,
1441                     reg);
1442         ufs_qcom_enable_test_bus(host);
1443         /*
1444          * Make sure the test bus configuration is
1445          * committed before returning.
1446          */
1447         mb();
1448
1449         return 0;
1450 }
1451
1452 static void ufs_qcom_dump_dbg_regs(struct ufs_hba *hba)
1453 {
1454         u32 reg;
1455         struct ufs_qcom_host *host;
1456
1457         host = ufshcd_get_variant(hba);
1458
1459         ufshcd_dump_regs(hba, REG_UFS_SYS1CLK_1US, 16 * 4,
1460                          "HCI Vendor Specific Registers ");
1461
1462         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_REG_OCSC);
1463         ufshcd_dump_regs(hba, reg, 44 * 4, "UFS_UFS_DBG_RD_REG_OCSC ");
1464
1465         reg = ufshcd_readl(hba, REG_UFS_CFG1);
1466         reg |= UTP_DBG_RAMS_EN;
1467         ufshcd_writel(hba, reg, REG_UFS_CFG1);
1468
1469         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_EDTL_RAM);
1470         ufshcd_dump_regs(hba, reg, 32 * 4, "UFS_UFS_DBG_RD_EDTL_RAM ");
1471
1472         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_DESC_RAM);
1473         ufshcd_dump_regs(hba, reg, 128 * 4, "UFS_UFS_DBG_RD_DESC_RAM ");
1474
1475         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_PRDT_RAM);
1476         ufshcd_dump_regs(hba, reg, 64 * 4, "UFS_UFS_DBG_RD_PRDT_RAM ");
1477
1478         /* clear bit 17 - UTP_DBG_RAMS_EN */
1479         ufshcd_rmwl(hba, UTP_DBG_RAMS_EN, 0, REG_UFS_CFG1);
1480
1481         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UAWM);
1482         ufshcd_dump_regs(hba, reg, 4 * 4, "UFS_DBG_RD_REG_UAWM ");
1483
1484         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UARM);
1485         ufshcd_dump_regs(hba, reg, 4 * 4, "UFS_DBG_RD_REG_UARM ");
1486
1487         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TXUC);
1488         ufshcd_dump_regs(hba, reg, 48 * 4, "UFS_DBG_RD_REG_TXUC ");
1489
1490         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_RXUC);
1491         ufshcd_dump_regs(hba, reg, 27 * 4, "UFS_DBG_RD_REG_RXUC ");
1492
1493         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_DFC);
1494         ufshcd_dump_regs(hba, reg, 19 * 4, "UFS_DBG_RD_REG_DFC ");
1495
1496         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TRLUT);
1497         ufshcd_dump_regs(hba, reg, 34 * 4, "UFS_DBG_RD_REG_TRLUT ");
1498
1499         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TMRLUT);
1500         ufshcd_dump_regs(hba, reg, 9 * 4, "UFS_DBG_RD_REG_TMRLUT ");
1501 }
1502
1503 /**
1504  * ufs_qcom_device_reset() - toggle the (optional) device reset line
1505  * @hba: per-adapter instance
1506  *
1507  * Toggles the (optional) reset line to reset the attached device.
1508  */
1509 static int ufs_qcom_device_reset(struct ufs_hba *hba)
1510 {
1511         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1512
1513         /* reset gpio is optional */
1514         if (!host->device_reset)
1515                 return -EOPNOTSUPP;
1516
1517         /*
1518          * The UFS device shall detect reset pulses of 1us, sleep for 10us to
1519          * be on the safe side.
1520          */
1521         ufs_qcom_device_reset_ctrl(hba, true);
1522         usleep_range(10, 15);
1523
1524         ufs_qcom_device_reset_ctrl(hba, false);
1525         usleep_range(10, 15);
1526
1527         return 0;
1528 }
1529
1530 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
1531 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1532                                         struct devfreq_dev_profile *p,
1533                                         struct devfreq_simple_ondemand_data *d)
1534 {
1535         p->polling_ms = 60;
1536         p->timer = DEVFREQ_TIMER_DELAYED;
1537         d->upthreshold = 70;
1538         d->downdifferential = 5;
1539 }
1540 #else
1541 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1542                 struct devfreq_dev_profile *p,
1543                 struct devfreq_simple_ondemand_data *data)
1544 {
1545 }
1546 #endif
1547
1548 static void ufs_qcom_reinit_notify(struct ufs_hba *hba)
1549 {
1550         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1551
1552         phy_power_off(host->generic_phy);
1553 }
1554
1555 /* Resources */
1556 static const struct ufshcd_res_info ufs_res_info[RES_MAX] = {
1557         {.name = "ufs_mem",},
1558         {.name = "mcq",},
1559         /* Submission Queue DAO */
1560         {.name = "mcq_sqd",},
1561         /* Submission Queue Interrupt Status */
1562         {.name = "mcq_sqis",},
1563         /* Completion Queue DAO */
1564         {.name = "mcq_cqd",},
1565         /* Completion Queue Interrupt Status */
1566         {.name = "mcq_cqis",},
1567         /* MCQ vendor specific */
1568         {.name = "mcq_vs",},
1569 };
1570
1571 static int ufs_qcom_mcq_config_resource(struct ufs_hba *hba)
1572 {
1573         struct platform_device *pdev = to_platform_device(hba->dev);
1574         struct ufshcd_res_info *res;
1575         struct resource *res_mem, *res_mcq;
1576         int i, ret;
1577
1578         memcpy(hba->res, ufs_res_info, sizeof(ufs_res_info));
1579
1580         for (i = 0; i < RES_MAX; i++) {
1581                 res = &hba->res[i];
1582                 res->resource = platform_get_resource_byname(pdev,
1583                                                              IORESOURCE_MEM,
1584                                                              res->name);
1585                 if (!res->resource) {
1586                         dev_info(hba->dev, "Resource %s not provided\n", res->name);
1587                         if (i == RES_UFS)
1588                                 return -ENODEV;
1589                         continue;
1590                 } else if (i == RES_UFS) {
1591                         res_mem = res->resource;
1592                         res->base = hba->mmio_base;
1593                         continue;
1594                 }
1595
1596                 res->base = devm_ioremap_resource(hba->dev, res->resource);
1597                 if (IS_ERR(res->base)) {
1598                         dev_err(hba->dev, "Failed to map res %s, err=%d\n",
1599                                          res->name, (int)PTR_ERR(res->base));
1600                         ret = PTR_ERR(res->base);
1601                         res->base = NULL;
1602                         return ret;
1603                 }
1604         }
1605
1606         /* MCQ resource provided in DT */
1607         res = &hba->res[RES_MCQ];
1608         /* Bail if MCQ resource is provided */
1609         if (res->base)
1610                 goto out;
1611
1612         /* Explicitly allocate MCQ resource from ufs_mem */
1613         res_mcq = devm_kzalloc(hba->dev, sizeof(*res_mcq), GFP_KERNEL);
1614         if (!res_mcq)
1615                 return -ENOMEM;
1616
1617         res_mcq->start = res_mem->start +
1618                          MCQ_SQATTR_OFFSET(hba->mcq_capabilities);
1619         res_mcq->end = res_mcq->start + hba->nr_hw_queues * MCQ_QCFG_SIZE - 1;
1620         res_mcq->flags = res_mem->flags;
1621         res_mcq->name = "mcq";
1622
1623         ret = insert_resource(&iomem_resource, res_mcq);
1624         if (ret) {
1625                 dev_err(hba->dev, "Failed to insert MCQ resource, err=%d\n",
1626                         ret);
1627                 return ret;
1628         }
1629
1630         res->base = devm_ioremap_resource(hba->dev, res_mcq);
1631         if (IS_ERR(res->base)) {
1632                 dev_err(hba->dev, "MCQ registers mapping failed, err=%d\n",
1633                         (int)PTR_ERR(res->base));
1634                 ret = PTR_ERR(res->base);
1635                 goto ioremap_err;
1636         }
1637
1638 out:
1639         hba->mcq_base = res->base;
1640         return 0;
1641 ioremap_err:
1642         res->base = NULL;
1643         remove_resource(res_mcq);
1644         return ret;
1645 }
1646
1647 static int ufs_qcom_op_runtime_config(struct ufs_hba *hba)
1648 {
1649         struct ufshcd_res_info *mem_res, *sqdao_res;
1650         struct ufshcd_mcq_opr_info_t *opr;
1651         int i;
1652
1653         mem_res = &hba->res[RES_UFS];
1654         sqdao_res = &hba->res[RES_MCQ_SQD];
1655
1656         if (!mem_res->base || !sqdao_res->base)
1657                 return -EINVAL;
1658
1659         for (i = 0; i < OPR_MAX; i++) {
1660                 opr = &hba->mcq_opr[i];
1661                 opr->offset = sqdao_res->resource->start -
1662                               mem_res->resource->start + 0x40 * i;
1663                 opr->stride = 0x100;
1664                 opr->base = sqdao_res->base + 0x40 * i;
1665         }
1666
1667         return 0;
1668 }
1669
1670 static int ufs_qcom_get_hba_mac(struct ufs_hba *hba)
1671 {
1672         /* Qualcomm HC supports up to 64 */
1673         return MAX_SUPP_MAC;
1674 }
1675
1676 static int ufs_qcom_get_outstanding_cqs(struct ufs_hba *hba,
1677                                         unsigned long *ocqs)
1678 {
1679         struct ufshcd_res_info *mcq_vs_res = &hba->res[RES_MCQ_VS];
1680
1681         if (!mcq_vs_res->base)
1682                 return -EINVAL;
1683
1684         *ocqs = readl(mcq_vs_res->base + UFS_MEM_CQIS_VS);
1685
1686         return 0;
1687 }
1688
1689 static void ufs_qcom_write_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1690 {
1691         struct device *dev = msi_desc_to_dev(desc);
1692         struct ufs_hba *hba = dev_get_drvdata(dev);
1693
1694         ufshcd_mcq_config_esi(hba, msg);
1695 }
1696
1697 static irqreturn_t ufs_qcom_mcq_esi_handler(int irq, void *data)
1698 {
1699         struct msi_desc *desc = data;
1700         struct device *dev = msi_desc_to_dev(desc);
1701         struct ufs_hba *hba = dev_get_drvdata(dev);
1702         u32 id = desc->msi_index;
1703         struct ufs_hw_queue *hwq = &hba->uhq[id];
1704
1705         ufshcd_mcq_write_cqis(hba, 0x1, id);
1706         ufshcd_mcq_poll_cqe_lock(hba, hwq);
1707
1708         return IRQ_HANDLED;
1709 }
1710
1711 static int ufs_qcom_config_esi(struct ufs_hba *hba)
1712 {
1713         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1714         struct msi_desc *desc;
1715         struct msi_desc *failed_desc = NULL;
1716         int nr_irqs, ret;
1717
1718         if (host->esi_enabled)
1719                 return 0;
1720
1721         /*
1722          * 1. We only handle CQs as of now.
1723          * 2. Poll queues do not need ESI.
1724          */
1725         nr_irqs = hba->nr_hw_queues - hba->nr_queues[HCTX_TYPE_POLL];
1726         ret = platform_msi_domain_alloc_irqs(hba->dev, nr_irqs,
1727                                              ufs_qcom_write_msi_msg);
1728         if (ret) {
1729                 dev_err(hba->dev, "Failed to request Platform MSI %d\n", ret);
1730                 return ret;
1731         }
1732
1733         msi_lock_descs(hba->dev);
1734         msi_for_each_desc(desc, hba->dev, MSI_DESC_ALL) {
1735                 ret = devm_request_irq(hba->dev, desc->irq,
1736                                        ufs_qcom_mcq_esi_handler,
1737                                        IRQF_SHARED, "qcom-mcq-esi", desc);
1738                 if (ret) {
1739                         dev_err(hba->dev, "%s: Fail to request IRQ for %d, err = %d\n",
1740                                 __func__, desc->irq, ret);
1741                         failed_desc = desc;
1742                         break;
1743                 }
1744         }
1745         msi_unlock_descs(hba->dev);
1746
1747         if (ret) {
1748                 /* Rewind */
1749                 msi_lock_descs(hba->dev);
1750                 msi_for_each_desc(desc, hba->dev, MSI_DESC_ALL) {
1751                         if (desc == failed_desc)
1752                                 break;
1753                         devm_free_irq(hba->dev, desc->irq, hba);
1754                 }
1755                 msi_unlock_descs(hba->dev);
1756                 platform_msi_domain_free_irqs(hba->dev);
1757         } else {
1758                 if (host->hw_ver.major == 6 && host->hw_ver.minor == 0 &&
1759                     host->hw_ver.step == 0)
1760                         ufshcd_rmwl(hba, ESI_VEC_MASK,
1761                                     FIELD_PREP(ESI_VEC_MASK, MAX_ESI_VEC - 1),
1762                                     REG_UFS_CFG3);
1763                 ufshcd_mcq_enable_esi(hba);
1764                 host->esi_enabled = true;
1765         }
1766
1767         return ret;
1768 }
1769
1770 /*
1771  * struct ufs_hba_qcom_vops - UFS QCOM specific variant operations
1772  *
1773  * The variant operations configure the necessary controller and PHY
1774  * handshake during initialization.
1775  */
1776 static const struct ufs_hba_variant_ops ufs_hba_qcom_vops = {
1777         .name                   = "qcom",
1778         .init                   = ufs_qcom_init,
1779         .exit                   = ufs_qcom_exit,
1780         .get_ufs_hci_version    = ufs_qcom_get_ufs_hci_version,
1781         .clk_scale_notify       = ufs_qcom_clk_scale_notify,
1782         .setup_clocks           = ufs_qcom_setup_clocks,
1783         .hce_enable_notify      = ufs_qcom_hce_enable_notify,
1784         .link_startup_notify    = ufs_qcom_link_startup_notify,
1785         .pwr_change_notify      = ufs_qcom_pwr_change_notify,
1786         .apply_dev_quirks       = ufs_qcom_apply_dev_quirks,
1787         .suspend                = ufs_qcom_suspend,
1788         .resume                 = ufs_qcom_resume,
1789         .dbg_register_dump      = ufs_qcom_dump_dbg_regs,
1790         .device_reset           = ufs_qcom_device_reset,
1791         .config_scaling_param = ufs_qcom_config_scaling_param,
1792         .program_key            = ufs_qcom_ice_program_key,
1793         .reinit_notify          = ufs_qcom_reinit_notify,
1794         .mcq_config_resource    = ufs_qcom_mcq_config_resource,
1795         .get_hba_mac            = ufs_qcom_get_hba_mac,
1796         .op_runtime_config      = ufs_qcom_op_runtime_config,
1797         .get_outstanding_cqs    = ufs_qcom_get_outstanding_cqs,
1798         .config_esi             = ufs_qcom_config_esi,
1799 };
1800
1801 /**
1802  * ufs_qcom_probe - probe routine of the driver
1803  * @pdev: pointer to Platform device handle
1804  *
1805  * Return: zero for success and non-zero for failure.
1806  */
1807 static int ufs_qcom_probe(struct platform_device *pdev)
1808 {
1809         int err;
1810         struct device *dev = &pdev->dev;
1811
1812         /* Perform generic probe */
1813         err = ufshcd_pltfrm_init(pdev, &ufs_hba_qcom_vops);
1814         if (err)
1815                 return dev_err_probe(dev, err, "ufshcd_pltfrm_init() failed\n");
1816
1817         return 0;
1818 }
1819
1820 /**
1821  * ufs_qcom_remove - set driver_data of the device to NULL
1822  * @pdev: pointer to platform device handle
1823  *
1824  * Always returns 0
1825  */
1826 static void ufs_qcom_remove(struct platform_device *pdev)
1827 {
1828         struct ufs_hba *hba =  platform_get_drvdata(pdev);
1829
1830         pm_runtime_get_sync(&(pdev)->dev);
1831         ufshcd_remove(hba);
1832         platform_msi_domain_free_irqs(hba->dev);
1833 }
1834
1835 static const struct of_device_id ufs_qcom_of_match[] __maybe_unused = {
1836         { .compatible = "qcom,ufshc"},
1837         {},
1838 };
1839 MODULE_DEVICE_TABLE(of, ufs_qcom_of_match);
1840
1841 #ifdef CONFIG_ACPI
1842 static const struct acpi_device_id ufs_qcom_acpi_match[] = {
1843         { "QCOM24A5" },
1844         { },
1845 };
1846 MODULE_DEVICE_TABLE(acpi, ufs_qcom_acpi_match);
1847 #endif
1848
1849 static const struct dev_pm_ops ufs_qcom_pm_ops = {
1850         SET_RUNTIME_PM_OPS(ufshcd_runtime_suspend, ufshcd_runtime_resume, NULL)
1851         .prepare         = ufshcd_suspend_prepare,
1852         .complete        = ufshcd_resume_complete,
1853 #ifdef CONFIG_PM_SLEEP
1854         .suspend         = ufshcd_system_suspend,
1855         .resume          = ufshcd_system_resume,
1856         .freeze          = ufshcd_system_freeze,
1857         .restore         = ufshcd_system_restore,
1858         .thaw            = ufshcd_system_thaw,
1859 #endif
1860 };
1861
1862 static struct platform_driver ufs_qcom_pltform = {
1863         .probe  = ufs_qcom_probe,
1864         .remove_new = ufs_qcom_remove,
1865         .driver = {
1866                 .name   = "ufshcd-qcom",
1867                 .pm     = &ufs_qcom_pm_ops,
1868                 .of_match_table = of_match_ptr(ufs_qcom_of_match),
1869                 .acpi_match_table = ACPI_PTR(ufs_qcom_acpi_match),
1870         },
1871 };
1872 module_platform_driver(ufs_qcom_pltform);
1873
1874 MODULE_LICENSE("GPL v2");