drivers/scsi/ufs/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/time.h>
   8 #include <linux/of.h>
   9 #include <linux/platform_device.h>
  10 #include <linux/phy/phy.h>
  11 #include <linux/gpio/consumer.h>
  12 #include <linux/reset-controller.h>
  13 #include <linux/devfreq.h>
  14
  15 #include "ufshcd.h"
  16 #include "ufshcd-pltfrm.h"
  17 #include "unipro.h"
  18 #include "ufs-qcom.h"
  19 #include "ufshci.h"
  20 #include "ufs_quirks.h"
  21 #define UFS_QCOM_DEFAULT_DBG_PRINT_EN   \
  22         (UFS_QCOM_DBG_PRINT_REGS_EN | UFS_QCOM_DBG_PRINT_TEST_BUS_EN)
  23
  24 enum {
  25         TSTBUS_UAWM,
  26         TSTBUS_UARM,
  27         TSTBUS_TXUC,
  28         TSTBUS_RXUC,
  29         TSTBUS_DFC,
  30         TSTBUS_TRLUT,
  31         TSTBUS_TMRLUT,
  32         TSTBUS_OCSC,
  33         TSTBUS_UTP_HCI,
  34         TSTBUS_COMBINED,
  35         TSTBUS_WRAPPER,
  36         TSTBUS_UNIPRO,
  37         TSTBUS_MAX,
  38 };
  39
  40 static struct ufs_qcom_host *ufs_qcom_hosts[MAX_UFS_QCOM_HOSTS];
  41
  42 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host);
  43 static int ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(struct ufs_hba *hba,
  44                                                        u32 clk_cycles);
  45
  46 static struct ufs_qcom_host *rcdev_to_ufs_host(struct reset_controller_dev *rcd)
  47 {
  48         return container_of(rcd, struct ufs_qcom_host, rcdev);
  49 }
  50
  51 static void ufs_qcom_dump_regs_wrapper(struct ufs_hba *hba, int offset, int len,
  52                                        const char *prefix, void *priv)
  53 {
  54         ufshcd_dump_regs(hba, offset, len * 4, prefix);
  55 }
  56
  57 static int ufs_qcom_get_connected_tx_lanes(struct ufs_hba *hba, u32 *tx_lanes)
  58 {
  59         int err = 0;
  60
  61         err = ufshcd_dme_get(hba,
  62                         UIC_ARG_MIB(PA_CONNECTEDTXDATALANES), tx_lanes);
  63         if (err)
  64                 dev_err(hba->dev, "%s: couldn't read PA_CONNECTEDTXDATALANES %d\n",
  65                                 __func__, err);
  66
  67         return err;
  68 }
  69
  70 static int ufs_qcom_host_clk_get(struct device *dev,
  71                 const char *name, struct clk **clk_out, bool optional)
  72 {
  73         struct clk *clk;
  74         int err = 0;
  75
  76         clk = devm_clk_get(dev, name);
  77         if (!IS_ERR(clk)) {
  78                 *clk_out = clk;
  79                 return 0;
  80         }
  81
  82         err = PTR_ERR(clk);
  83
  84         if (optional && err == -ENOENT) {
  85                 *clk_out = NULL;
  86                 return 0;
  87         }
  88
  89         if (err != -EPROBE_DEFER)
  90                 dev_err(dev, "failed to get %s err %d\n", name, err);
  91
  92         return err;
  93 }
  94
  95 static int ufs_qcom_host_clk_enable(struct device *dev,
  96                 const char *name, struct clk *clk)
  97 {
  98         int err = 0;
  99
 100         err = clk_prepare_enable(clk);
 101         if (err)
 102                 dev_err(dev, "%s: %s enable failed %d\n", __func__, name, err);
 103
 104         return err;
 105 }
 106
 107 static void ufs_qcom_disable_lane_clks(struct ufs_qcom_host *host)
 108 {
 109         if (!host->is_lane_clks_enabled)
 110                 return;
 111
 112         clk_disable_unprepare(host->tx_l1_sync_clk);
 113         clk_disable_unprepare(host->tx_l0_sync_clk);
 114         clk_disable_unprepare(host->rx_l1_sync_clk);
 115         clk_disable_unprepare(host->rx_l0_sync_clk);
 116
 117         host->is_lane_clks_enabled = false;
 118 }
 119
 120 static int ufs_qcom_enable_lane_clks(struct ufs_qcom_host *host)
 121 {
 122         int err = 0;
 123         struct device *dev = host->hba->dev;
 124
 125         if (host->is_lane_clks_enabled)
 126                 return 0;
 127
 128         err = ufs_qcom_host_clk_enable(dev, "rx_lane0_sync_clk",
 129                 host->rx_l0_sync_clk);
 130         if (err)
 131                 goto out;
 132
 133         err = ufs_qcom_host_clk_enable(dev, "tx_lane0_sync_clk",
 134                 host->tx_l0_sync_clk);
 135         if (err)
 136                 goto disable_rx_l0;
 137
 138         err = ufs_qcom_host_clk_enable(dev, "rx_lane1_sync_clk",
 139                         host->rx_l1_sync_clk);
 140         if (err)
 141                 goto disable_tx_l0;
 142
 143         err = ufs_qcom_host_clk_enable(dev, "tx_lane1_sync_clk",
 144                         host->tx_l1_sync_clk);
 145         if (err)
 146                 goto disable_rx_l1;
 147
 148         host->is_lane_clks_enabled = true;
 149         goto out;
 150
 151 disable_rx_l1:
 152         clk_disable_unprepare(host->rx_l1_sync_clk);
 153 disable_tx_l0:
 154         clk_disable_unprepare(host->tx_l0_sync_clk);
 155 disable_rx_l0:
 156         clk_disable_unprepare(host->rx_l0_sync_clk);
 157 out:
 158         return err;
 159 }
 160
 161 static int ufs_qcom_init_lane_clks(struct ufs_qcom_host *host)
 162 {
 163         int err = 0;
 164         struct device *dev = host->hba->dev;
 165
 166         if (has_acpi_companion(dev))
 167                 return 0;
 168
 169         err = ufs_qcom_host_clk_get(dev, "rx_lane0_sync_clk",
 170                                         &host->rx_l0_sync_clk, false);
 171         if (err)
 172                 goto out;
 173
 174         err = ufs_qcom_host_clk_get(dev, "tx_lane0_sync_clk",
 175                                         &host->tx_l0_sync_clk, false);
 176         if (err)
 177                 goto out;
 178
 179         /* In case of single lane per direction, don't read lane1 clocks */
 180         if (host->hba->lanes_per_direction > 1) {
 181                 err = ufs_qcom_host_clk_get(dev, "rx_lane1_sync_clk",
 182                         &host->rx_l1_sync_clk, false);
 183                 if (err)
 184                         goto out;
 185
 186                 err = ufs_qcom_host_clk_get(dev, "tx_lane1_sync_clk",
 187                         &host->tx_l1_sync_clk, true);
 188         }
 189 out:
 190         return err;
 191 }
 192
 193 static int ufs_qcom_link_startup_post_change(struct ufs_hba *hba)
 194 {
 195         u32 tx_lanes;
 196
 197         return ufs_qcom_get_connected_tx_lanes(hba, &tx_lanes);
 198 }
 199
 200 static int ufs_qcom_check_hibern8(struct ufs_hba *hba)
 201 {
 202         int err;
 203         u32 tx_fsm_val = 0;
 204         unsigned long timeout = jiffies + msecs_to_jiffies(HBRN8_POLL_TOUT_MS);
 205
 206         do {
 207                 err = ufshcd_dme_get(hba,
 208                                 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
 209                                         UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
 210                                 &tx_fsm_val);
 211                 if (err || tx_fsm_val == TX_FSM_HIBERN8)
 212                         break;
 213
 214                 /* sleep for max. 200us */
 215                 usleep_range(100, 200);
 216         } while (time_before(jiffies, timeout));
 217
 218         /*
 219          * we might have scheduled out for long during polling so
 220          * check the state again.
 221          */
 222         if (time_after(jiffies, timeout))
 223                 err = ufshcd_dme_get(hba,
 224                                 UIC_ARG_MIB_SEL(MPHY_TX_FSM_STATE,
 225                                         UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
 226                                 &tx_fsm_val);
 227
 228         if (err) {
 229                 dev_err(hba->dev, "%s: unable to get TX_FSM_STATE, err %d\n",
 230                                 __func__, err);
 231         } else if (tx_fsm_val != TX_FSM_HIBERN8) {
 232                 err = tx_fsm_val;
 233                 dev_err(hba->dev, "%s: invalid TX_FSM_STATE = %d\n",
 234                                 __func__, err);
 235         }
 236
 237         return err;
 238 }
 239
 240 static void ufs_qcom_select_unipro_mode(struct ufs_qcom_host *host)
 241 {
 242         ufshcd_rmwl(host->hba, QUNIPRO_SEL,
 243                    ufs_qcom_cap_qunipro(host) ? QUNIPRO_SEL : 0,
 244                    REG_UFS_CFG1);
 245         /* make sure above configuration is applied before we return */
 246         mb();
 247 }
 248
 249 /*
 250  * ufs_qcom_host_reset - reset host controller and PHY
 251  */
 252 static int ufs_qcom_host_reset(struct ufs_hba *hba)
 253 {
 254         int ret = 0;
 255         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 256         bool reenable_intr = false;
 257
 258         if (!host->core_reset) {
 259                 dev_warn(hba->dev, "%s: reset control not set\n", __func__);
 260                 goto out;
 261         }
 262
 263         reenable_intr = hba->is_irq_enabled;
 264         disable_irq(hba->irq);
 265         hba->is_irq_enabled = false;
 266
 267         ret = reset_control_assert(host->core_reset);
 268         if (ret) {
 269                 dev_err(hba->dev, "%s: core_reset assert failed, err = %d\n",
 270                                  __func__, ret);
 271                 goto out;
 272         }
 273
 274         /*
 275          * The hardware requirement for delay between assert/deassert
 276          * is at least 3-4 sleep clock (32.7KHz) cycles, which comes to
 277          * ~125us (4/32768). To be on the safe side add 200us delay.
 278          */
 279         usleep_range(200, 210);
 280
 281         ret = reset_control_deassert(host->core_reset);
 282         if (ret)
 283                 dev_err(hba->dev, "%s: core_reset deassert failed, err = %d\n",
 284                                  __func__, ret);
 285
 286         usleep_range(1000, 1100);
 287
 288         if (reenable_intr) {
 289                 enable_irq(hba->irq);
 290                 hba->is_irq_enabled = true;
 291         }
 292
 293 out:
 294         return ret;
 295 }
 296
 297 static int ufs_qcom_power_up_sequence(struct ufs_hba *hba)
 298 {
 299         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 300         struct phy *phy = host->generic_phy;
 301         int ret = 0;
 302         bool is_rate_B = (UFS_QCOM_LIMIT_HS_RATE == PA_HS_MODE_B)
 303                                                         ? true : false;
 304
 305         /* Reset UFS Host Controller and PHY */
 306         ret = ufs_qcom_host_reset(hba);
 307         if (ret)
 308                 dev_warn(hba->dev, "%s: host reset returned %d\n",
 309                                   __func__, ret);
 310
 311         if (is_rate_B)
 312                 phy_set_mode(phy, PHY_MODE_UFS_HS_B);
 313
 314         /* phy initialization - calibrate the phy */
 315         ret = phy_init(phy);
 316         if (ret) {
 317                 dev_err(hba->dev, "%s: phy init failed, ret = %d\n",
 318                         __func__, ret);
 319                 goto out;
 320         }
 321
 322         /* power on phy - start serdes and phy's power and clocks */
 323         ret = phy_power_on(phy);
 324         if (ret) {
 325                 dev_err(hba->dev, "%s: phy power on failed, ret = %d\n",
 326                         __func__, ret);
 327                 goto out_disable_phy;
 328         }
 329
 330         ufs_qcom_select_unipro_mode(host);
 331
 332         return 0;
 333
 334 out_disable_phy:
 335         phy_exit(phy);
 336 out:
 337         return ret;
 338 }
 339
 340 /*
 341  * The UTP controller has a number of internal clock gating cells (CGCs).
 342  * Internal hardware sub-modules within the UTP controller control the CGCs.
 343  * Hardware CGCs disable the clock to inactivate UTP sub-modules not involved
 344  * in a specific operation, UTP controller CGCs are by default disabled and
 345  * this function enables them (after every UFS link startup) to save some power
 346  * leakage.
 347  */
 348 static void ufs_qcom_enable_hw_clk_gating(struct ufs_hba *hba)
 349 {
 350         ufshcd_writel(hba,
 351                 ufshcd_readl(hba, REG_UFS_CFG2) | REG_UFS_CFG2_CGC_EN_ALL,
 352                 REG_UFS_CFG2);
 353
 354         /* Ensure that HW clock gating is enabled before next operations */
 355         mb();
 356 }
 357
 358 static int ufs_qcom_hce_enable_notify(struct ufs_hba *hba,
 359                                       enum ufs_notify_change_status status)
 360 {
 361         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 362         int err = 0;
 363
 364         switch (status) {
 365         case PRE_CHANGE:
 366                 ufs_qcom_power_up_sequence(hba);
 367                 /*
 368                  * The PHY PLL output is the source of tx/rx lane symbol
 369                  * clocks, hence, enable the lane clocks only after PHY
 370                  * is initialized.
 371                  */
 372                 err = ufs_qcom_enable_lane_clks(host);
 373                 break;
 374         case POST_CHANGE:
 375                 /* check if UFS PHY moved from DISABLED to HIBERN8 */
 376                 err = ufs_qcom_check_hibern8(hba);
 377                 ufs_qcom_enable_hw_clk_gating(hba);
 378                 ufs_qcom_ice_enable(host);
 379                 break;
 380         default:
 381                 dev_err(hba->dev, "%s: invalid status %d\n", __func__, status);
 382                 err = -EINVAL;
 383                 break;
 384         }
 385         return err;
 386 }
 387
 388 /*
 389  * Returns zero for success and non-zero in case of a failure
 390  */
 391 static int ufs_qcom_cfg_timers(struct ufs_hba *hba, u32 gear,
 392                                u32 hs, u32 rate, bool update_link_startup_timer)
 393 {
 394         int ret = 0;
 395         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 396         struct ufs_clk_info *clki;
 397         u32 core_clk_period_in_ns;
 398         u32 tx_clk_cycles_per_us = 0;
 399         unsigned long core_clk_rate = 0;
 400         u32 core_clk_cycles_per_us = 0;
 401
 402         static u32 pwm_fr_table[][2] = {
 403                 {UFS_PWM_G1, 0x1},
 404                 {UFS_PWM_G2, 0x1},
 405                 {UFS_PWM_G3, 0x1},
 406                 {UFS_PWM_G4, 0x1},
 407         };
 408
 409         static u32 hs_fr_table_rA[][2] = {
 410                 {UFS_HS_G1, 0x1F},
 411                 {UFS_HS_G2, 0x3e},
 412                 {UFS_HS_G3, 0x7D},
 413         };
 414
 415         static u32 hs_fr_table_rB[][2] = {
 416                 {UFS_HS_G1, 0x24},
 417                 {UFS_HS_G2, 0x49},
 418                 {UFS_HS_G3, 0x92},
 419         };
 420
 421         /*
 422          * The Qunipro controller does not use following registers:
 423          * SYS1CLK_1US_REG, TX_SYMBOL_CLK_1US_REG, CLK_NS_REG &
 424          * UFS_REG_PA_LINK_STARTUP_TIMER
 425          * But UTP controller uses SYS1CLK_1US_REG register for Interrupt
 426          * Aggregation logic.
 427         */
 428         if (ufs_qcom_cap_qunipro(host) && !ufshcd_is_intr_aggr_allowed(hba))
 429                 goto out;
 430
 431         if (gear == 0) {
 432                 dev_err(hba->dev, "%s: invalid gear = %d\n", __func__, gear);
 433                 goto out_error;
 434         }
 435
 436         list_for_each_entry(clki, &hba->clk_list_head, list) {
 437                 if (!strcmp(clki->name, "core_clk"))
 438                         core_clk_rate = clk_get_rate(clki->clk);
 439         }
 440
 441         /* If frequency is smaller than 1MHz, set to 1MHz */
 442         if (core_clk_rate < DEFAULT_CLK_RATE_HZ)
 443                 core_clk_rate = DEFAULT_CLK_RATE_HZ;
 444
 445         core_clk_cycles_per_us = core_clk_rate / USEC_PER_SEC;
 446         if (ufshcd_readl(hba, REG_UFS_SYS1CLK_1US) != core_clk_cycles_per_us) {
 447                 ufshcd_writel(hba, core_clk_cycles_per_us, REG_UFS_SYS1CLK_1US);
 448                 /*
 449                  * make sure above write gets applied before we return from
 450                  * this function.
 451                  */
 452                 mb();
 453         }
 454
 455         if (ufs_qcom_cap_qunipro(host))
 456                 goto out;
 457
 458         core_clk_period_in_ns = NSEC_PER_SEC / core_clk_rate;
 459         core_clk_period_in_ns <<= OFFSET_CLK_NS_REG;
 460         core_clk_period_in_ns &= MASK_CLK_NS_REG;
 461
 462         switch (hs) {
 463         case FASTAUTO_MODE:
 464         case FAST_MODE:
 465                 if (rate == PA_HS_MODE_A) {
 466                         if (gear > ARRAY_SIZE(hs_fr_table_rA)) {
 467                                 dev_err(hba->dev,
 468                                         "%s: index %d exceeds table size %zu\n",
 469                                         __func__, gear,
 470                                         ARRAY_SIZE(hs_fr_table_rA));
 471                                 goto out_error;
 472                         }
 473                         tx_clk_cycles_per_us = hs_fr_table_rA[gear-1][1];
 474                 } else if (rate == PA_HS_MODE_B) {
 475                         if (gear > ARRAY_SIZE(hs_fr_table_rB)) {
 476                                 dev_err(hba->dev,
 477                                         "%s: index %d exceeds table size %zu\n",
 478                                         __func__, gear,
 479                                         ARRAY_SIZE(hs_fr_table_rB));
 480                                 goto out_error;
 481                         }
 482                         tx_clk_cycles_per_us = hs_fr_table_rB[gear-1][1];
 483                 } else {
 484                         dev_err(hba->dev, "%s: invalid rate = %d\n",
 485                                 __func__, rate);
 486                         goto out_error;
 487                 }
 488                 break;
 489         case SLOWAUTO_MODE:
 490         case SLOW_MODE:
 491                 if (gear > ARRAY_SIZE(pwm_fr_table)) {
 492                         dev_err(hba->dev,
 493                                         "%s: index %d exceeds table size %zu\n",
 494                                         __func__, gear,
 495                                         ARRAY_SIZE(pwm_fr_table));
 496                         goto out_error;
 497                 }
 498                 tx_clk_cycles_per_us = pwm_fr_table[gear-1][1];
 499                 break;
 500         case UNCHANGED:
 501         default:
 502                 dev_err(hba->dev, "%s: invalid mode = %d\n", __func__, hs);
 503                 goto out_error;
 504         }
 505
 506         if (ufshcd_readl(hba, REG_UFS_TX_SYMBOL_CLK_NS_US) !=
 507             (core_clk_period_in_ns | tx_clk_cycles_per_us)) {
 508                 /* this register 2 fields shall be written at once */
 509                 ufshcd_writel(hba, core_clk_period_in_ns | tx_clk_cycles_per_us,
 510                               REG_UFS_TX_SYMBOL_CLK_NS_US);
 511                 /*
 512                  * make sure above write gets applied before we return from
 513                  * this function.
 514                  */
 515                 mb();
 516         }
 517
 518         if (update_link_startup_timer) {
 519                 ufshcd_writel(hba, ((core_clk_rate / MSEC_PER_SEC) * 100),
 520                               REG_UFS_PA_LINK_STARTUP_TIMER);
 521                 /*
 522                  * make sure that this configuration is applied before
 523                  * we return
 524                  */
 525                 mb();
 526         }
 527         goto out;
 528
 529 out_error:
 530         ret = -EINVAL;
 531 out:
 532         return ret;
 533 }
 534
 535 static int ufs_qcom_link_startup_notify(struct ufs_hba *hba,
 536                                         enum ufs_notify_change_status status)
 537 {
 538         int err = 0;
 539         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 540
 541         switch (status) {
 542         case PRE_CHANGE:
 543                 if (ufs_qcom_cfg_timers(hba, UFS_PWM_G1, SLOWAUTO_MODE,
 544                                         0, true)) {
 545                         dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
 546                                 __func__);
 547                         err = -EINVAL;
 548                         goto out;
 549                 }
 550
 551                 if (ufs_qcom_cap_qunipro(host))
 552                         /*
 553                          * set unipro core clock cycles to 150 & clear clock
 554                          * divider
 555                          */
 556                         err = ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba,
 557                                                                           150);
 558
 559                 /*
 560                  * Some UFS devices (and may be host) have issues if LCC is
 561                  * enabled. So we are setting PA_Local_TX_LCC_Enable to 0
 562                  * before link startup which will make sure that both host
 563                  * and device TX LCC are disabled once link startup is
 564                  * completed.
 565                  */
 566                 if (ufshcd_get_local_unipro_ver(hba) != UFS_UNIPRO_VER_1_41)
 567                         err = ufshcd_disable_host_tx_lcc(hba);
 568
 569                 break;
 570         case POST_CHANGE:
 571                 ufs_qcom_link_startup_post_change(hba);
 572                 break;
 573         default:
 574                 break;
 575         }
 576
 577 out:
 578         return err;
 579 }
 580
 581 static void ufs_qcom_device_reset_ctrl(struct ufs_hba *hba, bool asserted)
 582 {
 583         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 584
 585         /* reset gpio is optional */
 586         if (!host->device_reset)
 587                 return;
 588
 589         gpiod_set_value_cansleep(host->device_reset, asserted);
 590 }
 591
 592 static int ufs_qcom_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op)
 593 {
 594         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 595         struct phy *phy = host->generic_phy;
 596
 597         if (ufs_qcom_is_link_off(hba)) {
 598                 /*
 599                  * Disable the tx/rx lane symbol clocks before PHY is
 600                  * powered down as the PLL source should be disabled
 601                  * after downstream clocks are disabled.
 602                  */
 603                 ufs_qcom_disable_lane_clks(host);
 604                 phy_power_off(phy);
 605
 606                 /* reset the connected UFS device during power down */
 607                 ufs_qcom_device_reset_ctrl(hba, true);
 608
 609         } else if (!ufs_qcom_is_link_active(hba)) {
 610                 ufs_qcom_disable_lane_clks(host);
 611         }
 612
 613         return 0;
 614 }
 615
 616 static int ufs_qcom_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
 617 {
 618         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 619         struct phy *phy = host->generic_phy;
 620         int err;
 621
 622         if (ufs_qcom_is_link_off(hba)) {
 623                 err = phy_power_on(phy);
 624                 if (err) {
 625                         dev_err(hba->dev, "%s: failed PHY power on: %d\n",
 626                                 __func__, err);
 627                         return err;
 628                 }
 629
 630                 err = ufs_qcom_enable_lane_clks(host);
 631                 if (err)
 632                         return err;
 633
 634         } else if (!ufs_qcom_is_link_active(hba)) {
 635                 err = ufs_qcom_enable_lane_clks(host);
 636                 if (err)
 637                         return err;
 638         }
 639
 640         return ufs_qcom_ice_resume(host);
 641 }
 642
 643 static void ufs_qcom_dev_ref_clk_ctrl(struct ufs_qcom_host *host, bool enable)
 644 {
 645         if (host->dev_ref_clk_ctrl_mmio &&
 646             (enable ^ host->is_dev_ref_clk_enabled)) {
 647                 u32 temp = readl_relaxed(host->dev_ref_clk_ctrl_mmio);
 648
 649                 if (enable)
 650                         temp |= host->dev_ref_clk_en_mask;
 651                 else
 652                         temp &= ~host->dev_ref_clk_en_mask;
 653
 654                 /*
 655                  * If we are here to disable this clock it might be immediately
 656                  * after entering into hibern8 in which case we need to make
 657                  * sure that device ref_clk is active for specific time after
 658                  * hibern8 enter.
 659                  */
 660                 if (!enable) {
 661                         unsigned long gating_wait;
 662
 663                         gating_wait = host->hba->dev_info.clk_gating_wait_us;
 664                         if (!gating_wait) {
 665                                 udelay(1);
 666                         } else {
 667                                 /*
 668                                  * bRefClkGatingWaitTime defines the minimum
 669                                  * time for which the reference clock is
 670                                  * required by device during transition from
 671                                  * HS-MODE to LS-MODE or HIBERN8 state. Give it
 672                                  * more delay to be on the safe side.
 673                                  */
 674                                 gating_wait += 10;
 675                                 usleep_range(gating_wait, gating_wait + 10);
 676                         }
 677                 }
 678
 679                 writel_relaxed(temp, host->dev_ref_clk_ctrl_mmio);
 680
 681                 /*
 682                  * Make sure the write to ref_clk reaches the destination and
 683                  * not stored in a Write Buffer (WB).
 684                  */
 685                 readl(host->dev_ref_clk_ctrl_mmio);
 686
 687                 /*
 688                  * If we call hibern8 exit after this, we need to make sure that
 689                  * device ref_clk is stable for at least 1us before the hibern8
 690                  * exit command.
 691                  */
 692                 if (enable)
 693                         udelay(1);
 694
 695                 host->is_dev_ref_clk_enabled = enable;
 696         }
 697 }
 698
 699 static int ufs_qcom_pwr_change_notify(struct ufs_hba *hba,
 700                                 enum ufs_notify_change_status status,
 701                                 struct ufs_pa_layer_attr *dev_max_params,
 702                                 struct ufs_pa_layer_attr *dev_req_params)
 703 {
 704         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 705         struct ufs_dev_params ufs_qcom_cap;
 706         int ret = 0;
 707
 708         if (!dev_req_params) {
 709                 pr_err("%s: incoming dev_req_params is NULL\n", __func__);
 710                 ret = -EINVAL;
 711                 goto out;
 712         }
 713
 714         switch (status) {
 715         case PRE_CHANGE:
 716                 ufshcd_init_pwr_dev_param(&ufs_qcom_cap);
 717                 ufs_qcom_cap.hs_rate = UFS_QCOM_LIMIT_HS_RATE;
 718
 719                 if (host->hw_ver.major == 0x1) {
 720                         /*
 721                          * HS-G3 operations may not reliably work on legacy QCOM
 722                          * UFS host controller hardware even though capability
 723                          * exchange during link startup phase may end up
 724                          * negotiating maximum supported gear as G3.
 725                          * Hence downgrade the maximum supported gear to HS-G2.
 726                          */
 727                         if (ufs_qcom_cap.hs_tx_gear > UFS_HS_G2)
 728                                 ufs_qcom_cap.hs_tx_gear = UFS_HS_G2;
 729                         if (ufs_qcom_cap.hs_rx_gear > UFS_HS_G2)
 730                                 ufs_qcom_cap.hs_rx_gear = UFS_HS_G2;
 731                 }
 732
 733                 ret = ufshcd_get_pwr_dev_param(&ufs_qcom_cap,
 734                                                dev_max_params,
 735                                                dev_req_params);
 736                 if (ret) {
 737                         pr_err("%s: failed to determine capabilities\n",
 738                                         __func__);
 739                         goto out;
 740                 }
 741
 742                 /* enable the device ref clock before changing to HS mode */
 743                 if (!ufshcd_is_hs_mode(&hba->pwr_info) &&
 744                         ufshcd_is_hs_mode(dev_req_params))
 745                         ufs_qcom_dev_ref_clk_ctrl(host, true);
 746
 747                 if (host->hw_ver.major >= 0x4) {
 748                         ufshcd_dme_configure_adapt(hba,
 749                                                 dev_req_params->gear_tx,
 750                                                 PA_INITIAL_ADAPT);
 751                 }
 752                 break;
 753         case POST_CHANGE:
 754                 if (ufs_qcom_cfg_timers(hba, dev_req_params->gear_rx,
 755                                         dev_req_params->pwr_rx,
 756                                         dev_req_params->hs_rate, false)) {
 757                         dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
 758                                 __func__);
 759                         /*
 760                          * we return error code at the end of the routine,
 761                          * but continue to configure UFS_PHY_TX_LANE_ENABLE
 762                          * and bus voting as usual
 763                          */
 764                         ret = -EINVAL;
 765                 }
 766
 767                 /* cache the power mode parameters to use internally */
 768                 memcpy(&host->dev_req_params,
 769                                 dev_req_params, sizeof(*dev_req_params));
 770
 771                 /* disable the device ref clock if entered PWM mode */
 772                 if (ufshcd_is_hs_mode(&hba->pwr_info) &&
 773                         !ufshcd_is_hs_mode(dev_req_params))
 774                         ufs_qcom_dev_ref_clk_ctrl(host, false);
 775                 break;
 776         default:
 777                 ret = -EINVAL;
 778                 break;
 779         }
 780 out:
 781         return ret;
 782 }
 783
 784 static int ufs_qcom_quirk_host_pa_saveconfigtime(struct ufs_hba *hba)
 785 {
 786         int err;
 787         u32 pa_vs_config_reg1;
 788
 789         err = ufshcd_dme_get(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
 790                              &pa_vs_config_reg1);
 791         if (err)
 792                 goto out;
 793
 794         /* Allow extension of MSB bits of PA_SaveConfigTime attribute */
 795         err = ufshcd_dme_set(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
 796                             (pa_vs_config_reg1 | (1 << 12)));
 797
 798 out:
 799         return err;
 800 }
 801
 802 static int ufs_qcom_apply_dev_quirks(struct ufs_hba *hba)
 803 {
 804         int err = 0;
 805
 806         if (hba->dev_quirks & UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME)
 807                 err = ufs_qcom_quirk_host_pa_saveconfigtime(hba);
 808
 809         if (hba->dev_info.wmanufacturerid == UFS_VENDOR_WDC)
 810                 hba->dev_quirks |= UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE;
 811
 812         return err;
 813 }
 814
 815 static u32 ufs_qcom_get_ufs_hci_version(struct ufs_hba *hba)
 816 {
 817         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 818
 819         if (host->hw_ver.major == 0x1)
 820                 return ufshci_version(1, 1);
 821         else
 822                 return ufshci_version(2, 0);
 823 }
 824
 825 /**
 826  * ufs_qcom_advertise_quirks - advertise the known QCOM UFS controller quirks
 827  * @hba: host controller instance
 828  *
 829  * QCOM UFS host controller might have some non standard behaviours (quirks)
 830  * than what is specified by UFSHCI specification. Advertise all such
 831  * quirks to standard UFS host controller driver so standard takes them into
 832  * account.
 833  */
 834 static void ufs_qcom_advertise_quirks(struct ufs_hba *hba)
 835 {
 836         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 837
 838         if (host->hw_ver.major == 0x01) {
 839                 hba->quirks |= UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
 840                             | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP
 841                             | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE;
 842
 843                 if (host->hw_ver.minor == 0x0001 && host->hw_ver.step == 0x0001)
 844                         hba->quirks |= UFSHCD_QUIRK_BROKEN_INTR_AGGR;
 845
 846                 hba->quirks |= UFSHCD_QUIRK_BROKEN_LCC;
 847         }
 848
 849         if (host->hw_ver.major == 0x2) {
 850                 hba->quirks |= UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION;
 851
 852                 if (!ufs_qcom_cap_qunipro(host))
 853                         /* Legacy UniPro mode still need following quirks */
 854                         hba->quirks |= (UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
 855                                 | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE
 856                                 | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP);
 857         }
 858 }
 859
 860 static void ufs_qcom_set_caps(struct ufs_hba *hba)
 861 {
 862         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 863
 864         hba->caps |= UFSHCD_CAP_CLK_GATING | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
 865         hba->caps |= UFSHCD_CAP_CLK_SCALING;
 866         hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
 867         hba->caps |= UFSHCD_CAP_WB_EN;
 868         hba->caps |= UFSHCD_CAP_CRYPTO;
 869         hba->caps |= UFSHCD_CAP_AGGR_POWER_COLLAPSE;
 870
 871         if (host->hw_ver.major >= 0x2) {
 872                 host->caps = UFS_QCOM_CAP_QUNIPRO |
 873                              UFS_QCOM_CAP_RETAIN_SEC_CFG_AFTER_PWR_COLLAPSE;
 874         }
 875 }
 876
 877 /**
 878  * ufs_qcom_setup_clocks - enables/disable clocks
 879  * @hba: host controller instance
 880  * @on: If true, enable clocks else disable them.
 881  * @status: PRE_CHANGE or POST_CHANGE notify
 882  *
 883  * Returns 0 on success, non-zero on failure.
 884  */
 885 static int ufs_qcom_setup_clocks(struct ufs_hba *hba, bool on,
 886                                  enum ufs_notify_change_status status)
 887 {
 888         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 889         int err = 0;
 890
 891         /*
 892          * In case ufs_qcom_init() is not yet done, simply ignore.
 893          * This ufs_qcom_setup_clocks() shall be called from
 894          * ufs_qcom_init() after init is done.
 895          */
 896         if (!host)
 897                 return 0;
 898
 899         switch (status) {
 900         case PRE_CHANGE:
 901                 if (!on) {
 902                         if (!ufs_qcom_is_link_active(hba)) {
 903                                 /* disable device ref_clk */
 904                                 ufs_qcom_dev_ref_clk_ctrl(host, false);
 905                         }
 906                 }
 907                 break;
 908         case POST_CHANGE:
 909                 if (on) {
 910                         /* enable the device ref clock for HS mode*/
 911                         if (ufshcd_is_hs_mode(&hba->pwr_info))
 912                                 ufs_qcom_dev_ref_clk_ctrl(host, true);
 913                 }
 914                 break;
 915         }
 916
 917         return err;
 918 }
 919
 920 static int
 921 ufs_qcom_reset_assert(struct reset_controller_dev *rcdev, unsigned long id)
 922 {
 923         struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
 924
 925         /* Currently this code only knows about a single reset. */
 926         WARN_ON(id);
 927         ufs_qcom_assert_reset(host->hba);
 928         /* provide 1ms delay to let the reset pulse propagate. */
 929         usleep_range(1000, 1100);
 930         return 0;
 931 }
 932
 933 static int
 934 ufs_qcom_reset_deassert(struct reset_controller_dev *rcdev, unsigned long id)
 935 {
 936         struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
 937
 938         /* Currently this code only knows about a single reset. */
 939         WARN_ON(id);
 940         ufs_qcom_deassert_reset(host->hba);
 941
 942         /*
 943          * after reset deassertion, phy will need all ref clocks,
 944          * voltage, current to settle down before starting serdes.
 945          */
 946         usleep_range(1000, 1100);
 947         return 0;
 948 }
 949
 950 static const struct reset_control_ops ufs_qcom_reset_ops = {
 951         .assert = ufs_qcom_reset_assert,
 952         .deassert = ufs_qcom_reset_deassert,
 953 };
 954
 955 #define ANDROID_BOOT_DEV_MAX    30
 956 static char android_boot_dev[ANDROID_BOOT_DEV_MAX];
 957
 958 #ifndef MODULE
 959 static int __init get_android_boot_dev(char *str)
 960 {
 961         strlcpy(android_boot_dev, str, ANDROID_BOOT_DEV_MAX);
 962         return 1;
 963 }
 964 __setup("androidboot.bootdevice=", get_android_boot_dev);
 965 #endif
 966
 967 /**
 968  * ufs_qcom_init - bind phy with controller
 969  * @hba: host controller instance
 970  *
 971  * Binds PHY with controller and powers up PHY enabling clocks
 972  * and regulators.
 973  *
 974  * Returns -EPROBE_DEFER if binding fails, returns negative error
 975  * on phy power up failure and returns zero on success.
 976  */
 977 static int ufs_qcom_init(struct ufs_hba *hba)
 978 {
 979         int err;
 980         struct device *dev = hba->dev;
 981         struct platform_device *pdev = to_platform_device(dev);
 982         struct ufs_qcom_host *host;
 983         struct resource *res;
 984         struct ufs_clk_info *clki;
 985
 986         if (strlen(android_boot_dev) && strcmp(android_boot_dev, dev_name(dev)))
 987                 return -ENODEV;
 988
 989         host = devm_kzalloc(dev, sizeof(*host), GFP_KERNEL);
 990         if (!host) {
 991                 err = -ENOMEM;
 992                 dev_err(dev, "%s: no memory for qcom ufs host\n", __func__);
 993                 goto out;
 994         }
 995
 996         /* Make a two way bind between the qcom host and the hba */
 997         host->hba = hba;
 998         ufshcd_set_variant(hba, host);
 999
1000         /* Setup the reset control of HCI */
1001         host->core_reset = devm_reset_control_get(hba->dev, "rst");
1002         if (IS_ERR(host->core_reset)) {
1003                 err = PTR_ERR(host->core_reset);
1004                 dev_warn(dev, "Failed to get reset control %d\n", err);
1005                 host->core_reset = NULL;
1006                 err = 0;
1007         }
1008
1009         /* Fire up the reset controller. Failure here is non-fatal. */
1010         host->rcdev.of_node = dev->of_node;
1011         host->rcdev.ops = &ufs_qcom_reset_ops;
1012         host->rcdev.owner = dev->driver->owner;
1013         host->rcdev.nr_resets = 1;
1014         err = devm_reset_controller_register(dev, &host->rcdev);
1015         if (err) {
1016                 dev_warn(dev, "Failed to register reset controller\n");
1017                 err = 0;
1018         }
1019
1020         /*
1021          * voting/devoting device ref_clk source is time consuming hence
1022          * skip devoting it during aggressive clock gating. This clock
1023          * will still be gated off during runtime suspend.
1024          */
1025         host->generic_phy = devm_phy_get(dev, "ufsphy");
1026
1027         if (host->generic_phy == ERR_PTR(-EPROBE_DEFER)) {
1028                 /*
1029                  * UFS driver might be probed before the phy driver does.
1030                  * In that case we would like to return EPROBE_DEFER code.
1031                  */
1032                 err = -EPROBE_DEFER;
1033                 dev_warn(dev, "%s: required phy device. hasn't probed yet. err = %d\n",
1034                         __func__, err);
1035                 goto out_variant_clear;
1036         } else if (IS_ERR(host->generic_phy)) {
1037                 if (has_acpi_companion(dev)) {
1038                         host->generic_phy = NULL;
1039                 } else {
1040                         err = PTR_ERR(host->generic_phy);
1041                         dev_err(dev, "%s: PHY get failed %d\n", __func__, err);
1042                         goto out_variant_clear;
1043                 }
1044         }
1045
1046         host->device_reset = devm_gpiod_get_optional(dev, "reset",
1047                                                      GPIOD_OUT_HIGH);
1048         if (IS_ERR(host->device_reset)) {
1049                 err = PTR_ERR(host->device_reset);
1050                 if (err != -EPROBE_DEFER)
1051                         dev_err(dev, "failed to acquire reset gpio: %d\n", err);
1052                 goto out_variant_clear;
1053         }
1054
1055         ufs_qcom_get_controller_revision(hba, &host->hw_ver.major,
1056                 &host->hw_ver.minor, &host->hw_ver.step);
1057
1058         /*
1059          * for newer controllers, device reference clock control bit has
1060          * moved inside UFS controller register address space itself.
1061          */
1062         if (host->hw_ver.major >= 0x02) {
1063                 host->dev_ref_clk_ctrl_mmio = hba->mmio_base + REG_UFS_CFG1;
1064                 host->dev_ref_clk_en_mask = BIT(26);
1065         } else {
1066                 /* "dev_ref_clk_ctrl_mem" is optional resource */
1067                 res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
1068                                                    "dev_ref_clk_ctrl_mem");
1069                 if (res) {
1070                         host->dev_ref_clk_ctrl_mmio =
1071                                         devm_ioremap_resource(dev, res);
1072                         if (IS_ERR(host->dev_ref_clk_ctrl_mmio))
1073                                 host->dev_ref_clk_ctrl_mmio = NULL;
1074                         host->dev_ref_clk_en_mask = BIT(5);
1075                 }
1076         }
1077
1078         list_for_each_entry(clki, &hba->clk_list_head, list) {
1079                 if (!strcmp(clki->name, "core_clk_unipro"))
1080                         clki->keep_link_active = true;
1081         }
1082
1083         err = ufs_qcom_init_lane_clks(host);
1084         if (err)
1085                 goto out_variant_clear;
1086
1087         ufs_qcom_set_caps(hba);
1088         ufs_qcom_advertise_quirks(hba);
1089
1090         err = ufs_qcom_ice_init(host);
1091         if (err)
1092                 goto out_variant_clear;
1093
1094         ufs_qcom_setup_clocks(hba, true, POST_CHANGE);
1095
1096         if (hba->dev->id < MAX_UFS_QCOM_HOSTS)
1097                 ufs_qcom_hosts[hba->dev->id] = host;
1098
1099         host->dbg_print_en |= UFS_QCOM_DEFAULT_DBG_PRINT_EN;
1100         ufs_qcom_get_default_testbus_cfg(host);
1101         err = ufs_qcom_testbus_config(host);
1102         if (err) {
1103                 dev_warn(dev, "%s: failed to configure the testbus %d\n",
1104                                 __func__, err);
1105                 err = 0;
1106         }
1107
1108         goto out;
1109
1110 out_variant_clear:
1111         ufshcd_set_variant(hba, NULL);
1112 out:
1113         return err;
1114 }
1115
1116 static void ufs_qcom_exit(struct ufs_hba *hba)
1117 {
1118         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1119
1120         ufs_qcom_disable_lane_clks(host);
1121         phy_power_off(host->generic_phy);
1122         phy_exit(host->generic_phy);
1123 }
1124
1125 static int ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(struct ufs_hba *hba,
1126                                                        u32 clk_cycles)
1127 {
1128         int err;
1129         u32 core_clk_ctrl_reg;
1130
1131         if (clk_cycles > DME_VS_CORE_CLK_CTRL_MAX_CORE_CLK_1US_CYCLES_MASK)
1132                 return -EINVAL;
1133
1134         err = ufshcd_dme_get(hba,
1135                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1136                             &core_clk_ctrl_reg);
1137         if (err)
1138                 goto out;
1139
1140         core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_MAX_CORE_CLK_1US_CYCLES_MASK;
1141         core_clk_ctrl_reg |= clk_cycles;
1142
1143         /* Clear CORE_CLK_DIV_EN */
1144         core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1145
1146         err = ufshcd_dme_set(hba,
1147                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1148                             core_clk_ctrl_reg);
1149 out:
1150         return err;
1151 }
1152
1153 static int ufs_qcom_clk_scale_up_pre_change(struct ufs_hba *hba)
1154 {
1155         /* nothing to do as of now */
1156         return 0;
1157 }
1158
1159 static int ufs_qcom_clk_scale_up_post_change(struct ufs_hba *hba)
1160 {
1161         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1162
1163         if (!ufs_qcom_cap_qunipro(host))
1164                 return 0;
1165
1166         /* set unipro core clock cycles to 150 and clear clock divider */
1167         return ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba, 150);
1168 }
1169
1170 static int ufs_qcom_clk_scale_down_pre_change(struct ufs_hba *hba)
1171 {
1172         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1173         int err;
1174         u32 core_clk_ctrl_reg;
1175
1176         if (!ufs_qcom_cap_qunipro(host))
1177                 return 0;
1178
1179         err = ufshcd_dme_get(hba,
1180                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1181                             &core_clk_ctrl_reg);
1182
1183         /* make sure CORE_CLK_DIV_EN is cleared */
1184         if (!err &&
1185             (core_clk_ctrl_reg & DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT)) {
1186                 core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1187                 err = ufshcd_dme_set(hba,
1188                                     UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1189                                     core_clk_ctrl_reg);
1190         }
1191
1192         return err;
1193 }
1194
1195 static int ufs_qcom_clk_scale_down_post_change(struct ufs_hba *hba)
1196 {
1197         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1198
1199         if (!ufs_qcom_cap_qunipro(host))
1200                 return 0;
1201
1202         /* set unipro core clock cycles to 75 and clear clock divider */
1203         return ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba, 75);
1204 }
1205
1206 static int ufs_qcom_clk_scale_notify(struct ufs_hba *hba,
1207                 bool scale_up, enum ufs_notify_change_status status)
1208 {
1209         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1210         struct ufs_pa_layer_attr *dev_req_params = &host->dev_req_params;
1211         int err = 0;
1212
1213         if (status == PRE_CHANGE) {
1214                 if (scale_up)
1215                         err = ufs_qcom_clk_scale_up_pre_change(hba);
1216                 else
1217                         err = ufs_qcom_clk_scale_down_pre_change(hba);
1218         } else {
1219                 if (scale_up)
1220                         err = ufs_qcom_clk_scale_up_post_change(hba);
1221                 else
1222                         err = ufs_qcom_clk_scale_down_post_change(hba);
1223
1224                 if (err || !dev_req_params)
1225                         goto out;
1226
1227                 ufs_qcom_cfg_timers(hba,
1228                                     dev_req_params->gear_rx,
1229                                     dev_req_params->pwr_rx,
1230                                     dev_req_params->hs_rate,
1231                                     false);
1232         }
1233
1234 out:
1235         return err;
1236 }
1237
1238 static void ufs_qcom_print_hw_debug_reg_all(struct ufs_hba *hba,
1239                 void *priv, void (*print_fn)(struct ufs_hba *hba,
1240                 int offset, int num_regs, const char *str, void *priv))
1241 {
1242         u32 reg;
1243         struct ufs_qcom_host *host;
1244
1245         if (unlikely(!hba)) {
1246                 pr_err("%s: hba is NULL\n", __func__);
1247                 return;
1248         }
1249         if (unlikely(!print_fn)) {
1250                 dev_err(hba->dev, "%s: print_fn is NULL\n", __func__);
1251                 return;
1252         }
1253
1254         host = ufshcd_get_variant(hba);
1255         if (!(host->dbg_print_en & UFS_QCOM_DBG_PRINT_REGS_EN))
1256                 return;
1257
1258         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_REG_OCSC);
1259         print_fn(hba, reg, 44, "UFS_UFS_DBG_RD_REG_OCSC ", priv);
1260
1261         reg = ufshcd_readl(hba, REG_UFS_CFG1);
1262         reg |= UTP_DBG_RAMS_EN;
1263         ufshcd_writel(hba, reg, REG_UFS_CFG1);
1264
1265         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_EDTL_RAM);
1266         print_fn(hba, reg, 32, "UFS_UFS_DBG_RD_EDTL_RAM ", priv);
1267
1268         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_DESC_RAM);
1269         print_fn(hba, reg, 128, "UFS_UFS_DBG_RD_DESC_RAM ", priv);
1270
1271         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_PRDT_RAM);
1272         print_fn(hba, reg, 64, "UFS_UFS_DBG_RD_PRDT_RAM ", priv);
1273
1274         /* clear bit 17 - UTP_DBG_RAMS_EN */
1275         ufshcd_rmwl(hba, UTP_DBG_RAMS_EN, 0, REG_UFS_CFG1);
1276
1277         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UAWM);
1278         print_fn(hba, reg, 4, "UFS_DBG_RD_REG_UAWM ", priv);
1279
1280         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UARM);
1281         print_fn(hba, reg, 4, "UFS_DBG_RD_REG_UARM ", priv);
1282
1283         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TXUC);
1284         print_fn(hba, reg, 48, "UFS_DBG_RD_REG_TXUC ", priv);
1285
1286         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_RXUC);
1287         print_fn(hba, reg, 27, "UFS_DBG_RD_REG_RXUC ", priv);
1288
1289         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_DFC);
1290         print_fn(hba, reg, 19, "UFS_DBG_RD_REG_DFC ", priv);
1291
1292         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TRLUT);
1293         print_fn(hba, reg, 34, "UFS_DBG_RD_REG_TRLUT ", priv);
1294
1295         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TMRLUT);
1296         print_fn(hba, reg, 9, "UFS_DBG_RD_REG_TMRLUT ", priv);
1297 }
1298
1299 static void ufs_qcom_enable_test_bus(struct ufs_qcom_host *host)
1300 {
1301         if (host->dbg_print_en & UFS_QCOM_DBG_PRINT_TEST_BUS_EN) {
1302                 ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN,
1303                                 UFS_REG_TEST_BUS_EN, REG_UFS_CFG1);
1304                 ufshcd_rmwl(host->hba, TEST_BUS_EN, TEST_BUS_EN, REG_UFS_CFG1);
1305         } else {
1306                 ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN, 0, REG_UFS_CFG1);
1307                 ufshcd_rmwl(host->hba, TEST_BUS_EN, 0, REG_UFS_CFG1);
1308         }
1309 }
1310
1311 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host)
1312 {
1313         /* provide a legal default configuration */
1314         host->testbus.select_major = TSTBUS_UNIPRO;
1315         host->testbus.select_minor = 37;
1316 }
1317
1318 static bool ufs_qcom_testbus_cfg_is_ok(struct ufs_qcom_host *host)
1319 {
1320         if (host->testbus.select_major >= TSTBUS_MAX) {
1321                 dev_err(host->hba->dev,
1322                         "%s: UFS_CFG1[TEST_BUS_SEL} may not equal 0x%05X\n",
1323                         __func__, host->testbus.select_major);
1324                 return false;
1325         }
1326
1327         return true;
1328 }
1329
1330 int ufs_qcom_testbus_config(struct ufs_qcom_host *host)
1331 {
1332         int reg;
1333         int offset;
1334         u32 mask = TEST_BUS_SUB_SEL_MASK;
1335
1336         if (!host)
1337                 return -EINVAL;
1338
1339         if (!ufs_qcom_testbus_cfg_is_ok(host))
1340                 return -EPERM;
1341
1342         switch (host->testbus.select_major) {
1343         case TSTBUS_UAWM:
1344                 reg = UFS_TEST_BUS_CTRL_0;
1345                 offset = 24;
1346                 break;
1347         case TSTBUS_UARM:
1348                 reg = UFS_TEST_BUS_CTRL_0;
1349                 offset = 16;
1350                 break;
1351         case TSTBUS_TXUC:
1352                 reg = UFS_TEST_BUS_CTRL_0;
1353                 offset = 8;
1354                 break;
1355         case TSTBUS_RXUC:
1356                 reg = UFS_TEST_BUS_CTRL_0;
1357                 offset = 0;
1358                 break;
1359         case TSTBUS_DFC:
1360                 reg = UFS_TEST_BUS_CTRL_1;
1361                 offset = 24;
1362                 break;
1363         case TSTBUS_TRLUT:
1364                 reg = UFS_TEST_BUS_CTRL_1;
1365                 offset = 16;
1366                 break;
1367         case TSTBUS_TMRLUT:
1368                 reg = UFS_TEST_BUS_CTRL_1;
1369                 offset = 8;
1370                 break;
1371         case TSTBUS_OCSC:
1372                 reg = UFS_TEST_BUS_CTRL_1;
1373                 offset = 0;
1374                 break;
1375         case TSTBUS_WRAPPER:
1376                 reg = UFS_TEST_BUS_CTRL_2;
1377                 offset = 16;
1378                 break;
1379         case TSTBUS_COMBINED:
1380                 reg = UFS_TEST_BUS_CTRL_2;
1381                 offset = 8;
1382                 break;
1383         case TSTBUS_UTP_HCI:
1384                 reg = UFS_TEST_BUS_CTRL_2;
1385                 offset = 0;
1386                 break;
1387         case TSTBUS_UNIPRO:
1388                 reg = UFS_UNIPRO_CFG;
1389                 offset = 20;
1390                 mask = 0xFFF;
1391                 break;
1392         /*
1393          * No need for a default case, since
1394          * ufs_qcom_testbus_cfg_is_ok() checks that the configuration
1395          * is legal
1396          */
1397         }
1398         mask <<= offset;
1399         ufshcd_rmwl(host->hba, TEST_BUS_SEL,
1400                     (u32)host->testbus.select_major << 19,
1401                     REG_UFS_CFG1);
1402         ufshcd_rmwl(host->hba, mask,
1403                     (u32)host->testbus.select_minor << offset,
1404                     reg);
1405         ufs_qcom_enable_test_bus(host);
1406         /*
1407          * Make sure the test bus configuration is
1408          * committed before returning.
1409          */
1410         mb();
1411
1412         return 0;
1413 }
1414
1415 static void ufs_qcom_dump_dbg_regs(struct ufs_hba *hba)
1416 {
1417         ufshcd_dump_regs(hba, REG_UFS_SYS1CLK_1US, 16 * 4,
1418                          "HCI Vendor Specific Registers ");
1419
1420         ufs_qcom_print_hw_debug_reg_all(hba, NULL, ufs_qcom_dump_regs_wrapper);
1421 }
1422
1423 /**
1424  * ufs_qcom_device_reset() - toggle the (optional) device reset line
1425  * @hba: per-adapter instance
1426  *
1427  * Toggles the (optional) reset line to reset the attached device.
1428  */
1429 static int ufs_qcom_device_reset(struct ufs_hba *hba)
1430 {
1431         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1432
1433         /* reset gpio is optional */
1434         if (!host->device_reset)
1435                 return -EOPNOTSUPP;
1436
1437         /*
1438          * The UFS device shall detect reset pulses of 1us, sleep for 10us to
1439          * be on the safe side.
1440          */
1441         ufs_qcom_device_reset_ctrl(hba, true);
1442         usleep_range(10, 15);
1443
1444         ufs_qcom_device_reset_ctrl(hba, false);
1445         usleep_range(10, 15);
1446
1447         return 0;
1448 }
1449
1450 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
1451 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1452                                           struct devfreq_dev_profile *p,
1453                                           void *data)
1454 {
1455         static struct devfreq_simple_ondemand_data *d;
1456
1457         if (!data)
1458                 return;
1459
1460         d = (struct devfreq_simple_ondemand_data *)data;
1461         p->polling_ms = 60;
1462         d->upthreshold = 70;
1463         d->downdifferential = 5;
1464 }
1465 #else
1466 static void ufs_qcom_config_scaling_param(struct ufs_hba *hba,
1467                                           struct devfreq_dev_profile *p,
1468                                           void *data)
1469 {
1470 }
1471 #endif
1472
1473 /*
1474  * struct ufs_hba_qcom_vops - UFS QCOM specific variant operations
1475  *
1476  * The variant operations configure the necessary controller and PHY
1477  * handshake during initialization.
1478  */
1479 static const struct ufs_hba_variant_ops ufs_hba_qcom_vops = {
1480         .name                   = "qcom",
1481         .init                   = ufs_qcom_init,
1482         .exit                   = ufs_qcom_exit,
1483         .get_ufs_hci_version    = ufs_qcom_get_ufs_hci_version,
1484         .clk_scale_notify       = ufs_qcom_clk_scale_notify,
1485         .setup_clocks           = ufs_qcom_setup_clocks,
1486         .hce_enable_notify      = ufs_qcom_hce_enable_notify,
1487         .link_startup_notify    = ufs_qcom_link_startup_notify,
1488         .pwr_change_notify      = ufs_qcom_pwr_change_notify,
1489         .apply_dev_quirks       = ufs_qcom_apply_dev_quirks,
1490         .suspend                = ufs_qcom_suspend,
1491         .resume                 = ufs_qcom_resume,
1492         .dbg_register_dump      = ufs_qcom_dump_dbg_regs,
1493         .device_reset           = ufs_qcom_device_reset,
1494         .config_scaling_param = ufs_qcom_config_scaling_param,
1495         .program_key            = ufs_qcom_ice_program_key,
1496 };
1497
1498 /**
1499  * ufs_qcom_probe - probe routine of the driver
1500  * @pdev: pointer to Platform device handle
1501  *
1502  * Return zero for success and non-zero for failure
1503  */
1504 static int ufs_qcom_probe(struct platform_device *pdev)
1505 {
1506         int err;
1507         struct device *dev = &pdev->dev;
1508
1509         /* Perform generic probe */
1510         err = ufshcd_pltfrm_init(pdev, &ufs_hba_qcom_vops);
1511         if (err)
1512                 dev_err(dev, "ufshcd_pltfrm_init() failed %d\n", err);
1513
1514         return err;
1515 }
1516
1517 /**
1518  * ufs_qcom_remove - set driver_data of the device to NULL
1519  * @pdev: pointer to platform device handle
1520  *
1521  * Always returns 0
1522  */
1523 static int ufs_qcom_remove(struct platform_device *pdev)
1524 {
1525         struct ufs_hba *hba =  platform_get_drvdata(pdev);
1526
1527         pm_runtime_get_sync(&(pdev)->dev);
1528         ufshcd_remove(hba);
1529         return 0;
1530 }
1531
1532 static const struct of_device_id ufs_qcom_of_match[] = {
1533         { .compatible = "qcom,ufshc"},
1534         {},
1535 };
1536 MODULE_DEVICE_TABLE(of, ufs_qcom_of_match);
1537
1538 #ifdef CONFIG_ACPI
1539 static const struct acpi_device_id ufs_qcom_acpi_match[] = {
1540         { "QCOM24A5" },
1541         { },
1542 };
1543 MODULE_DEVICE_TABLE(acpi, ufs_qcom_acpi_match);
1544 #endif
1545
1546 static const struct dev_pm_ops ufs_qcom_pm_ops = {
1547         SET_SYSTEM_SLEEP_PM_OPS(ufshcd_system_suspend, ufshcd_system_resume)
1548         SET_RUNTIME_PM_OPS(ufshcd_runtime_suspend, ufshcd_runtime_resume, NULL)
1549         .prepare         = ufshcd_suspend_prepare,
1550         .complete        = ufshcd_resume_complete,
1551 };
1552
1553 static struct platform_driver ufs_qcom_pltform = {
1554         .probe  = ufs_qcom_probe,
1555         .remove = ufs_qcom_remove,
1556         .shutdown = ufshcd_pltfrm_shutdown,
1557         .driver = {
1558                 .name   = "ufshcd-qcom",
1559                 .pm     = &ufs_qcom_pm_ops,
1560                 .of_match_table = of_match_ptr(ufs_qcom_of_match),
1561                 .acpi_match_table = ACPI_PTR(ufs_qcom_acpi_match),
1562         },
1563 };
1564 module_platform_driver(ufs_qcom_pltform);
1565
1566 MODULE_LICENSE("GPL v2");