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
  14 #include "ufshcd.h"
  15 #include "ufshcd-pltfrm.h"
  16 #include "unipro.h"
  17 #include "ufs-qcom.h"
  18 #include "ufshci.h"
  19 #include "ufs_quirks.h"
  20 #define UFS_QCOM_DEFAULT_DBG_PRINT_EN   \
  21         (UFS_QCOM_DBG_PRINT_REGS_EN | UFS_QCOM_DBG_PRINT_TEST_BUS_EN)
  22
  23 enum {
  24         TSTBUS_UAWM,
  25         TSTBUS_UARM,
  26         TSTBUS_TXUC,
  27         TSTBUS_RXUC,
  28         TSTBUS_DFC,
  29         TSTBUS_TRLUT,
  30         TSTBUS_TMRLUT,
  31         TSTBUS_OCSC,
  32         TSTBUS_UTP_HCI,
  33         TSTBUS_COMBINED,
  34         TSTBUS_WRAPPER,
  35         TSTBUS_UNIPRO,
  36         TSTBUS_MAX,
  37 };
  38
  39 static struct ufs_qcom_host *ufs_qcom_hosts[MAX_UFS_QCOM_HOSTS];
  40
  41 static int ufs_qcom_set_bus_vote(struct ufs_qcom_host *host, int vote);
  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 static int ufs_qcom_power_up_sequence(struct ufs_hba *hba)
 250 {
 251         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 252         struct phy *phy = host->generic_phy;
 253         int ret = 0;
 254         bool is_rate_B = (UFS_QCOM_LIMIT_HS_RATE == PA_HS_MODE_B)
 255                                                         ? true : false;
 256
 257         if (is_rate_B)
 258                 phy_set_mode(phy, PHY_MODE_UFS_HS_B);
 259
 260         /* phy initialization - calibrate the phy */
 261         ret = phy_init(phy);
 262         if (ret) {
 263                 dev_err(hba->dev, "%s: phy init failed, ret = %d\n",
 264                         __func__, ret);
 265                 goto out;
 266         }
 267
 268         /* power on phy - start serdes and phy's power and clocks */
 269         ret = phy_power_on(phy);
 270         if (ret) {
 271                 dev_err(hba->dev, "%s: phy power on failed, ret = %d\n",
 272                         __func__, ret);
 273                 goto out_disable_phy;
 274         }
 275
 276         ufs_qcom_select_unipro_mode(host);
 277
 278         return 0;
 279
 280 out_disable_phy:
 281         phy_exit(phy);
 282 out:
 283         return ret;
 284 }
 285
 286 /*
 287  * The UTP controller has a number of internal clock gating cells (CGCs).
 288  * Internal hardware sub-modules within the UTP controller control the CGCs.
 289  * Hardware CGCs disable the clock to inactivate UTP sub-modules not involved
 290  * in a specific operation, UTP controller CGCs are by default disabled and
 291  * this function enables them (after every UFS link startup) to save some power
 292  * leakage.
 293  */
 294 static void ufs_qcom_enable_hw_clk_gating(struct ufs_hba *hba)
 295 {
 296         ufshcd_writel(hba,
 297                 ufshcd_readl(hba, REG_UFS_CFG2) | REG_UFS_CFG2_CGC_EN_ALL,
 298                 REG_UFS_CFG2);
 299
 300         /* Ensure that HW clock gating is enabled before next operations */
 301         mb();
 302 }
 303
 304 static int ufs_qcom_hce_enable_notify(struct ufs_hba *hba,
 305                                       enum ufs_notify_change_status status)
 306 {
 307         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 308         int err = 0;
 309
 310         switch (status) {
 311         case PRE_CHANGE:
 312                 ufs_qcom_power_up_sequence(hba);
 313                 /*
 314                  * The PHY PLL output is the source of tx/rx lane symbol
 315                  * clocks, hence, enable the lane clocks only after PHY
 316                  * is initialized.
 317                  */
 318                 err = ufs_qcom_enable_lane_clks(host);
 319                 break;
 320         case POST_CHANGE:
 321                 /* check if UFS PHY moved from DISABLED to HIBERN8 */
 322                 err = ufs_qcom_check_hibern8(hba);
 323                 ufs_qcom_enable_hw_clk_gating(hba);
 324
 325                 break;
 326         default:
 327                 dev_err(hba->dev, "%s: invalid status %d\n", __func__, status);
 328                 err = -EINVAL;
 329                 break;
 330         }
 331         return err;
 332 }
 333
 334 /**
 335  * Returns zero for success and non-zero in case of a failure
 336  */
 337 static int ufs_qcom_cfg_timers(struct ufs_hba *hba, u32 gear,
 338                                u32 hs, u32 rate, bool update_link_startup_timer)
 339 {
 340         int ret = 0;
 341         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 342         struct ufs_clk_info *clki;
 343         u32 core_clk_period_in_ns;
 344         u32 tx_clk_cycles_per_us = 0;
 345         unsigned long core_clk_rate = 0;
 346         u32 core_clk_cycles_per_us = 0;
 347
 348         static u32 pwm_fr_table[][2] = {
 349                 {UFS_PWM_G1, 0x1},
 350                 {UFS_PWM_G2, 0x1},
 351                 {UFS_PWM_G3, 0x1},
 352                 {UFS_PWM_G4, 0x1},
 353         };
 354
 355         static u32 hs_fr_table_rA[][2] = {
 356                 {UFS_HS_G1, 0x1F},
 357                 {UFS_HS_G2, 0x3e},
 358                 {UFS_HS_G3, 0x7D},
 359         };
 360
 361         static u32 hs_fr_table_rB[][2] = {
 362                 {UFS_HS_G1, 0x24},
 363                 {UFS_HS_G2, 0x49},
 364                 {UFS_HS_G3, 0x92},
 365         };
 366
 367         /*
 368          * The Qunipro controller does not use following registers:
 369          * SYS1CLK_1US_REG, TX_SYMBOL_CLK_1US_REG, CLK_NS_REG &
 370          * UFS_REG_PA_LINK_STARTUP_TIMER
 371          * But UTP controller uses SYS1CLK_1US_REG register for Interrupt
 372          * Aggregation logic.
 373         */
 374         if (ufs_qcom_cap_qunipro(host) && !ufshcd_is_intr_aggr_allowed(hba))
 375                 goto out;
 376
 377         if (gear == 0) {
 378                 dev_err(hba->dev, "%s: invalid gear = %d\n", __func__, gear);
 379                 goto out_error;
 380         }
 381
 382         list_for_each_entry(clki, &hba->clk_list_head, list) {
 383                 if (!strcmp(clki->name, "core_clk"))
 384                         core_clk_rate = clk_get_rate(clki->clk);
 385         }
 386
 387         /* If frequency is smaller than 1MHz, set to 1MHz */
 388         if (core_clk_rate < DEFAULT_CLK_RATE_HZ)
 389                 core_clk_rate = DEFAULT_CLK_RATE_HZ;
 390
 391         core_clk_cycles_per_us = core_clk_rate / USEC_PER_SEC;
 392         if (ufshcd_readl(hba, REG_UFS_SYS1CLK_1US) != core_clk_cycles_per_us) {
 393                 ufshcd_writel(hba, core_clk_cycles_per_us, REG_UFS_SYS1CLK_1US);
 394                 /*
 395                  * make sure above write gets applied before we return from
 396                  * this function.
 397                  */
 398                 mb();
 399         }
 400
 401         if (ufs_qcom_cap_qunipro(host))
 402                 goto out;
 403
 404         core_clk_period_in_ns = NSEC_PER_SEC / core_clk_rate;
 405         core_clk_period_in_ns <<= OFFSET_CLK_NS_REG;
 406         core_clk_period_in_ns &= MASK_CLK_NS_REG;
 407
 408         switch (hs) {
 409         case FASTAUTO_MODE:
 410         case FAST_MODE:
 411                 if (rate == PA_HS_MODE_A) {
 412                         if (gear > ARRAY_SIZE(hs_fr_table_rA)) {
 413                                 dev_err(hba->dev,
 414                                         "%s: index %d exceeds table size %zu\n",
 415                                         __func__, gear,
 416                                         ARRAY_SIZE(hs_fr_table_rA));
 417                                 goto out_error;
 418                         }
 419                         tx_clk_cycles_per_us = hs_fr_table_rA[gear-1][1];
 420                 } else if (rate == PA_HS_MODE_B) {
 421                         if (gear > ARRAY_SIZE(hs_fr_table_rB)) {
 422                                 dev_err(hba->dev,
 423                                         "%s: index %d exceeds table size %zu\n",
 424                                         __func__, gear,
 425                                         ARRAY_SIZE(hs_fr_table_rB));
 426                                 goto out_error;
 427                         }
 428                         tx_clk_cycles_per_us = hs_fr_table_rB[gear-1][1];
 429                 } else {
 430                         dev_err(hba->dev, "%s: invalid rate = %d\n",
 431                                 __func__, rate);
 432                         goto out_error;
 433                 }
 434                 break;
 435         case SLOWAUTO_MODE:
 436         case SLOW_MODE:
 437                 if (gear > ARRAY_SIZE(pwm_fr_table)) {
 438                         dev_err(hba->dev,
 439                                         "%s: index %d exceeds table size %zu\n",
 440                                         __func__, gear,
 441                                         ARRAY_SIZE(pwm_fr_table));
 442                         goto out_error;
 443                 }
 444                 tx_clk_cycles_per_us = pwm_fr_table[gear-1][1];
 445                 break;
 446         case UNCHANGED:
 447         default:
 448                 dev_err(hba->dev, "%s: invalid mode = %d\n", __func__, hs);
 449                 goto out_error;
 450         }
 451
 452         if (ufshcd_readl(hba, REG_UFS_TX_SYMBOL_CLK_NS_US) !=
 453             (core_clk_period_in_ns | tx_clk_cycles_per_us)) {
 454                 /* this register 2 fields shall be written at once */
 455                 ufshcd_writel(hba, core_clk_period_in_ns | tx_clk_cycles_per_us,
 456                               REG_UFS_TX_SYMBOL_CLK_NS_US);
 457                 /*
 458                  * make sure above write gets applied before we return from
 459                  * this function.
 460                  */
 461                 mb();
 462         }
 463
 464         if (update_link_startup_timer) {
 465                 ufshcd_writel(hba, ((core_clk_rate / MSEC_PER_SEC) * 100),
 466                               REG_UFS_PA_LINK_STARTUP_TIMER);
 467                 /*
 468                  * make sure that this configuration is applied before
 469                  * we return
 470                  */
 471                 mb();
 472         }
 473         goto out;
 474
 475 out_error:
 476         ret = -EINVAL;
 477 out:
 478         return ret;
 479 }
 480
 481 static int ufs_qcom_link_startup_notify(struct ufs_hba *hba,
 482                                         enum ufs_notify_change_status status)
 483 {
 484         int err = 0;
 485         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 486
 487         switch (status) {
 488         case PRE_CHANGE:
 489                 if (ufs_qcom_cfg_timers(hba, UFS_PWM_G1, SLOWAUTO_MODE,
 490                                         0, true)) {
 491                         dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
 492                                 __func__);
 493                         err = -EINVAL;
 494                         goto out;
 495                 }
 496
 497                 if (ufs_qcom_cap_qunipro(host))
 498                         /*
 499                          * set unipro core clock cycles to 150 & clear clock
 500                          * divider
 501                          */
 502                         err = ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba,
 503                                                                           150);
 504
 505                 /*
 506                  * Some UFS devices (and may be host) have issues if LCC is
 507                  * enabled. So we are setting PA_Local_TX_LCC_Enable to 0
 508                  * before link startup which will make sure that both host
 509                  * and device TX LCC are disabled once link startup is
 510                  * completed.
 511                  */
 512                 if (ufshcd_get_local_unipro_ver(hba) != UFS_UNIPRO_VER_1_41)
 513                         err = ufshcd_dme_set(hba,
 514                                         UIC_ARG_MIB(PA_LOCAL_TX_LCC_ENABLE),
 515                                         0);
 516
 517                 break;
 518         case POST_CHANGE:
 519                 ufs_qcom_link_startup_post_change(hba);
 520                 break;
 521         default:
 522                 break;
 523         }
 524
 525 out:
 526         return err;
 527 }
 528
 529 static int ufs_qcom_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op)
 530 {
 531         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 532         struct phy *phy = host->generic_phy;
 533         int ret = 0;
 534
 535         if (ufs_qcom_is_link_off(hba)) {
 536                 /*
 537                  * Disable the tx/rx lane symbol clocks before PHY is
 538                  * powered down as the PLL source should be disabled
 539                  * after downstream clocks are disabled.
 540                  */
 541                 ufs_qcom_disable_lane_clks(host);
 542                 phy_power_off(phy);
 543
 544         } else if (!ufs_qcom_is_link_active(hba)) {
 545                 ufs_qcom_disable_lane_clks(host);
 546         }
 547
 548         return ret;
 549 }
 550
 551 static int ufs_qcom_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
 552 {
 553         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 554         struct phy *phy = host->generic_phy;
 555         int err;
 556
 557         if (ufs_qcom_is_link_off(hba)) {
 558                 err = phy_power_on(phy);
 559                 if (err) {
 560                         dev_err(hba->dev, "%s: failed PHY power on: %d\n",
 561                                 __func__, err);
 562                         return err;
 563                 }
 564
 565                 err = ufs_qcom_enable_lane_clks(host);
 566                 if (err)
 567                         return err;
 568
 569         } else if (!ufs_qcom_is_link_active(hba)) {
 570                 err = ufs_qcom_enable_lane_clks(host);
 571                 if (err)
 572                         return err;
 573         }
 574
 575         hba->is_sys_suspended = false;
 576         return 0;
 577 }
 578
 579 #ifdef CONFIG_MSM_BUS_SCALING
 580 static int ufs_qcom_get_bus_vote(struct ufs_qcom_host *host,
 581                 const char *speed_mode)
 582 {
 583         struct device *dev = host->hba->dev;
 584         struct device_node *np = dev->of_node;
 585         int err;
 586         const char *key = "qcom,bus-vector-names";
 587
 588         if (!speed_mode) {
 589                 err = -EINVAL;
 590                 goto out;
 591         }
 592
 593         if (host->bus_vote.is_max_bw_needed && !!strcmp(speed_mode, "MIN"))
 594                 err = of_property_match_string(np, key, "MAX");
 595         else
 596                 err = of_property_match_string(np, key, speed_mode);
 597
 598 out:
 599         if (err < 0)
 600                 dev_err(dev, "%s: Invalid %s mode %d\n",
 601                                 __func__, speed_mode, err);
 602         return err;
 603 }
 604
 605 static void ufs_qcom_get_speed_mode(struct ufs_pa_layer_attr *p, char *result)
 606 {
 607         int gear = max_t(u32, p->gear_rx, p->gear_tx);
 608         int lanes = max_t(u32, p->lane_rx, p->lane_tx);
 609         int pwr;
 610
 611         /* default to PWM Gear 1, Lane 1 if power mode is not initialized */
 612         if (!gear)
 613                 gear = 1;
 614
 615         if (!lanes)
 616                 lanes = 1;
 617
 618         if (!p->pwr_rx && !p->pwr_tx) {
 619                 pwr = SLOWAUTO_MODE;
 620                 snprintf(result, BUS_VECTOR_NAME_LEN, "MIN");
 621         } else if (p->pwr_rx == FAST_MODE || p->pwr_rx == FASTAUTO_MODE ||
 622                  p->pwr_tx == FAST_MODE || p->pwr_tx == FASTAUTO_MODE) {
 623                 pwr = FAST_MODE;
 624                 snprintf(result, BUS_VECTOR_NAME_LEN, "%s_R%s_G%d_L%d", "HS",
 625                          p->hs_rate == PA_HS_MODE_B ? "B" : "A", gear, lanes);
 626         } else {
 627                 pwr = SLOW_MODE;
 628                 snprintf(result, BUS_VECTOR_NAME_LEN, "%s_G%d_L%d",
 629                          "PWM", gear, lanes);
 630         }
 631 }
 632
 633 static int ufs_qcom_set_bus_vote(struct ufs_qcom_host *host, int vote)
 634 {
 635         int err = 0;
 636
 637         if (vote != host->bus_vote.curr_vote) {
 638                 err = msm_bus_scale_client_update_request(
 639                                 host->bus_vote.client_handle, vote);
 640                 if (err) {
 641                         dev_err(host->hba->dev,
 642                                 "%s: msm_bus_scale_client_update_request() failed: bus_client_handle=0x%x, vote=%d, err=%d\n",
 643                                 __func__, host->bus_vote.client_handle,
 644                                 vote, err);
 645                         goto out;
 646                 }
 647
 648                 host->bus_vote.curr_vote = vote;
 649         }
 650 out:
 651         return err;
 652 }
 653
 654 static int ufs_qcom_update_bus_bw_vote(struct ufs_qcom_host *host)
 655 {
 656         int vote;
 657         int err = 0;
 658         char mode[BUS_VECTOR_NAME_LEN];
 659
 660         ufs_qcom_get_speed_mode(&host->dev_req_params, mode);
 661
 662         vote = ufs_qcom_get_bus_vote(host, mode);
 663         if (vote >= 0)
 664                 err = ufs_qcom_set_bus_vote(host, vote);
 665         else
 666                 err = vote;
 667
 668         if (err)
 669                 dev_err(host->hba->dev, "%s: failed %d\n", __func__, err);
 670         else
 671                 host->bus_vote.saved_vote = vote;
 672         return err;
 673 }
 674
 675 static ssize_t
 676 show_ufs_to_mem_max_bus_bw(struct device *dev, struct device_attribute *attr,
 677                         char *buf)
 678 {
 679         struct ufs_hba *hba = dev_get_drvdata(dev);
 680         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 681
 682         return snprintf(buf, PAGE_SIZE, "%u\n",
 683                         host->bus_vote.is_max_bw_needed);
 684 }
 685
 686 static ssize_t
 687 store_ufs_to_mem_max_bus_bw(struct device *dev, struct device_attribute *attr,
 688                 const char *buf, size_t count)
 689 {
 690         struct ufs_hba *hba = dev_get_drvdata(dev);
 691         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 692         uint32_t value;
 693
 694         if (!kstrtou32(buf, 0, &value)) {
 695                 host->bus_vote.is_max_bw_needed = !!value;
 696                 ufs_qcom_update_bus_bw_vote(host);
 697         }
 698
 699         return count;
 700 }
 701
 702 static int ufs_qcom_bus_register(struct ufs_qcom_host *host)
 703 {
 704         int err;
 705         struct msm_bus_scale_pdata *bus_pdata;
 706         struct device *dev = host->hba->dev;
 707         struct platform_device *pdev = to_platform_device(dev);
 708         struct device_node *np = dev->of_node;
 709
 710         bus_pdata = msm_bus_cl_get_pdata(pdev);
 711         if (!bus_pdata) {
 712                 dev_err(dev, "%s: failed to get bus vectors\n", __func__);
 713                 err = -ENODATA;
 714                 goto out;
 715         }
 716
 717         err = of_property_count_strings(np, "qcom,bus-vector-names");
 718         if (err < 0 || err != bus_pdata->num_usecases) {
 719                 dev_err(dev, "%s: qcom,bus-vector-names not specified correctly %d\n",
 720                                 __func__, err);
 721                 goto out;
 722         }
 723
 724         host->bus_vote.client_handle = msm_bus_scale_register_client(bus_pdata);
 725         if (!host->bus_vote.client_handle) {
 726                 dev_err(dev, "%s: msm_bus_scale_register_client failed\n",
 727                                 __func__);
 728                 err = -EFAULT;
 729                 goto out;
 730         }
 731
 732         /* cache the vote index for minimum and maximum bandwidth */
 733         host->bus_vote.min_bw_vote = ufs_qcom_get_bus_vote(host, "MIN");
 734         host->bus_vote.max_bw_vote = ufs_qcom_get_bus_vote(host, "MAX");
 735
 736         host->bus_vote.max_bus_bw.show = show_ufs_to_mem_max_bus_bw;
 737         host->bus_vote.max_bus_bw.store = store_ufs_to_mem_max_bus_bw;
 738         sysfs_attr_init(&host->bus_vote.max_bus_bw.attr);
 739         host->bus_vote.max_bus_bw.attr.name = "max_bus_bw";
 740         host->bus_vote.max_bus_bw.attr.mode = S_IRUGO | S_IWUSR;
 741         err = device_create_file(dev, &host->bus_vote.max_bus_bw);
 742 out:
 743         return err;
 744 }
 745 #else /* CONFIG_MSM_BUS_SCALING */
 746 static int ufs_qcom_update_bus_bw_vote(struct ufs_qcom_host *host)
 747 {
 748         return 0;
 749 }
 750
 751 static int ufs_qcom_set_bus_vote(struct ufs_qcom_host *host, int vote)
 752 {
 753         return 0;
 754 }
 755
 756 static int ufs_qcom_bus_register(struct ufs_qcom_host *host)
 757 {
 758         return 0;
 759 }
 760 #endif /* CONFIG_MSM_BUS_SCALING */
 761
 762 static void ufs_qcom_dev_ref_clk_ctrl(struct ufs_qcom_host *host, bool enable)
 763 {
 764         if (host->dev_ref_clk_ctrl_mmio &&
 765             (enable ^ host->is_dev_ref_clk_enabled)) {
 766                 u32 temp = readl_relaxed(host->dev_ref_clk_ctrl_mmio);
 767
 768                 if (enable)
 769                         temp |= host->dev_ref_clk_en_mask;
 770                 else
 771                         temp &= ~host->dev_ref_clk_en_mask;
 772
 773                 /*
 774                  * If we are here to disable this clock it might be immediately
 775                  * after entering into hibern8 in which case we need to make
 776                  * sure that device ref_clk is active at least 1us after the
 777                  * hibern8 enter.
 778                  */
 779                 if (!enable)
 780                         udelay(1);
 781
 782                 writel_relaxed(temp, host->dev_ref_clk_ctrl_mmio);
 783
 784                 /*
 785                  * Make sure the write to ref_clk reaches the destination and
 786                  * not stored in a Write Buffer (WB).
 787                  */
 788                 readl(host->dev_ref_clk_ctrl_mmio);
 789
 790                 /*
 791                  * If we call hibern8 exit after this, we need to make sure that
 792                  * device ref_clk is stable for at least 1us before the hibern8
 793                  * exit command.
 794                  */
 795                 if (enable)
 796                         udelay(1);
 797
 798                 host->is_dev_ref_clk_enabled = enable;
 799         }
 800 }
 801
 802 static int ufs_qcom_pwr_change_notify(struct ufs_hba *hba,
 803                                 enum ufs_notify_change_status status,
 804                                 struct ufs_pa_layer_attr *dev_max_params,
 805                                 struct ufs_pa_layer_attr *dev_req_params)
 806 {
 807         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 808         struct ufs_dev_params ufs_qcom_cap;
 809         int ret = 0;
 810
 811         if (!dev_req_params) {
 812                 pr_err("%s: incoming dev_req_params is NULL\n", __func__);
 813                 ret = -EINVAL;
 814                 goto out;
 815         }
 816
 817         switch (status) {
 818         case PRE_CHANGE:
 819                 ufs_qcom_cap.tx_lanes = UFS_QCOM_LIMIT_NUM_LANES_TX;
 820                 ufs_qcom_cap.rx_lanes = UFS_QCOM_LIMIT_NUM_LANES_RX;
 821                 ufs_qcom_cap.hs_rx_gear = UFS_QCOM_LIMIT_HSGEAR_RX;
 822                 ufs_qcom_cap.hs_tx_gear = UFS_QCOM_LIMIT_HSGEAR_TX;
 823                 ufs_qcom_cap.pwm_rx_gear = UFS_QCOM_LIMIT_PWMGEAR_RX;
 824                 ufs_qcom_cap.pwm_tx_gear = UFS_QCOM_LIMIT_PWMGEAR_TX;
 825                 ufs_qcom_cap.rx_pwr_pwm = UFS_QCOM_LIMIT_RX_PWR_PWM;
 826                 ufs_qcom_cap.tx_pwr_pwm = UFS_QCOM_LIMIT_TX_PWR_PWM;
 827                 ufs_qcom_cap.rx_pwr_hs = UFS_QCOM_LIMIT_RX_PWR_HS;
 828                 ufs_qcom_cap.tx_pwr_hs = UFS_QCOM_LIMIT_TX_PWR_HS;
 829                 ufs_qcom_cap.hs_rate = UFS_QCOM_LIMIT_HS_RATE;
 830                 ufs_qcom_cap.desired_working_mode =
 831                                         UFS_QCOM_LIMIT_DESIRED_MODE;
 832
 833                 if (host->hw_ver.major == 0x1) {
 834                         /*
 835                          * HS-G3 operations may not reliably work on legacy QCOM
 836                          * UFS host controller hardware even though capability
 837                          * exchange during link startup phase may end up
 838                          * negotiating maximum supported gear as G3.
 839                          * Hence downgrade the maximum supported gear to HS-G2.
 840                          */
 841                         if (ufs_qcom_cap.hs_tx_gear > UFS_HS_G2)
 842                                 ufs_qcom_cap.hs_tx_gear = UFS_HS_G2;
 843                         if (ufs_qcom_cap.hs_rx_gear > UFS_HS_G2)
 844                                 ufs_qcom_cap.hs_rx_gear = UFS_HS_G2;
 845                 }
 846
 847                 ret = ufshcd_get_pwr_dev_param(&ufs_qcom_cap,
 848                                                dev_max_params,
 849                                                dev_req_params);
 850                 if (ret) {
 851                         pr_err("%s: failed to determine capabilities\n",
 852                                         __func__);
 853                         goto out;
 854                 }
 855
 856                 /* enable the device ref clock before changing to HS mode */
 857                 if (!ufshcd_is_hs_mode(&hba->pwr_info) &&
 858                         ufshcd_is_hs_mode(dev_req_params))
 859                         ufs_qcom_dev_ref_clk_ctrl(host, true);
 860                 break;
 861         case POST_CHANGE:
 862                 if (ufs_qcom_cfg_timers(hba, dev_req_params->gear_rx,
 863                                         dev_req_params->pwr_rx,
 864                                         dev_req_params->hs_rate, false)) {
 865                         dev_err(hba->dev, "%s: ufs_qcom_cfg_timers() failed\n",
 866                                 __func__);
 867                         /*
 868                          * we return error code at the end of the routine,
 869                          * but continue to configure UFS_PHY_TX_LANE_ENABLE
 870                          * and bus voting as usual
 871                          */
 872                         ret = -EINVAL;
 873                 }
 874
 875                 /* cache the power mode parameters to use internally */
 876                 memcpy(&host->dev_req_params,
 877                                 dev_req_params, sizeof(*dev_req_params));
 878                 ufs_qcom_update_bus_bw_vote(host);
 879
 880                 /* disable the device ref clock if entered PWM mode */
 881                 if (ufshcd_is_hs_mode(&hba->pwr_info) &&
 882                         !ufshcd_is_hs_mode(dev_req_params))
 883                         ufs_qcom_dev_ref_clk_ctrl(host, false);
 884                 break;
 885         default:
 886                 ret = -EINVAL;
 887                 break;
 888         }
 889 out:
 890         return ret;
 891 }
 892
 893 static int ufs_qcom_quirk_host_pa_saveconfigtime(struct ufs_hba *hba)
 894 {
 895         int err;
 896         u32 pa_vs_config_reg1;
 897
 898         err = ufshcd_dme_get(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
 899                              &pa_vs_config_reg1);
 900         if (err)
 901                 goto out;
 902
 903         /* Allow extension of MSB bits of PA_SaveConfigTime attribute */
 904         err = ufshcd_dme_set(hba, UIC_ARG_MIB(PA_VS_CONFIG_REG1),
 905                             (pa_vs_config_reg1 | (1 << 12)));
 906
 907 out:
 908         return err;
 909 }
 910
 911 static int ufs_qcom_apply_dev_quirks(struct ufs_hba *hba,
 912                                      struct ufs_dev_desc *card)
 913 {
 914         int err = 0;
 915
 916         if (hba->dev_quirks & UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME)
 917                 err = ufs_qcom_quirk_host_pa_saveconfigtime(hba);
 918
 919         return err;
 920 }
 921
 922 static u32 ufs_qcom_get_ufs_hci_version(struct ufs_hba *hba)
 923 {
 924         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 925
 926         if (host->hw_ver.major == 0x1)
 927                 return UFSHCI_VERSION_11;
 928         else
 929                 return UFSHCI_VERSION_20;
 930 }
 931
 932 /**
 933  * ufs_qcom_advertise_quirks - advertise the known QCOM UFS controller quirks
 934  * @hba: host controller instance
 935  *
 936  * QCOM UFS host controller might have some non standard behaviours (quirks)
 937  * than what is specified by UFSHCI specification. Advertise all such
 938  * quirks to standard UFS host controller driver so standard takes them into
 939  * account.
 940  */
 941 static void ufs_qcom_advertise_quirks(struct ufs_hba *hba)
 942 {
 943         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 944
 945         if (host->hw_ver.major == 0x01) {
 946                 hba->quirks |= UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
 947                             | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP
 948                             | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE;
 949
 950                 if (host->hw_ver.minor == 0x0001 && host->hw_ver.step == 0x0001)
 951                         hba->quirks |= UFSHCD_QUIRK_BROKEN_INTR_AGGR;
 952
 953                 hba->quirks |= UFSHCD_QUIRK_BROKEN_LCC;
 954         }
 955
 956         if (host->hw_ver.major == 0x2) {
 957                 hba->quirks |= UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION;
 958
 959                 if (!ufs_qcom_cap_qunipro(host))
 960                         /* Legacy UniPro mode still need following quirks */
 961                         hba->quirks |= (UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
 962                                 | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE
 963                                 | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP);
 964         }
 965 }
 966
 967 static void ufs_qcom_set_caps(struct ufs_hba *hba)
 968 {
 969         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 970
 971         hba->caps |= UFSHCD_CAP_CLK_GATING | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
 972         hba->caps |= UFSHCD_CAP_CLK_SCALING;
 973         hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
 974
 975         if (host->hw_ver.major >= 0x2) {
 976                 host->caps = UFS_QCOM_CAP_QUNIPRO |
 977                              UFS_QCOM_CAP_RETAIN_SEC_CFG_AFTER_PWR_COLLAPSE;
 978         }
 979 }
 980
 981 /**
 982  * ufs_qcom_setup_clocks - enables/disable clocks
 983  * @hba: host controller instance
 984  * @on: If true, enable clocks else disable them.
 985  * @status: PRE_CHANGE or POST_CHANGE notify
 986  *
 987  * Returns 0 on success, non-zero on failure.
 988  */
 989 static int ufs_qcom_setup_clocks(struct ufs_hba *hba, bool on,
 990                                  enum ufs_notify_change_status status)
 991 {
 992         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
 993         int err;
 994         int vote = 0;
 995
 996         /*
 997          * In case ufs_qcom_init() is not yet done, simply ignore.
 998          * This ufs_qcom_setup_clocks() shall be called from
 999          * ufs_qcom_init() after init is done.
1000          */
1001         if (!host)
1002                 return 0;
1003
1004         if (on && (status == POST_CHANGE)) {
1005                 /* enable the device ref clock for HS mode*/
1006                 if (ufshcd_is_hs_mode(&hba->pwr_info))
1007                         ufs_qcom_dev_ref_clk_ctrl(host, true);
1008                 vote = host->bus_vote.saved_vote;
1009                 if (vote == host->bus_vote.min_bw_vote)
1010                         ufs_qcom_update_bus_bw_vote(host);
1011
1012         } else if (!on && (status == PRE_CHANGE)) {
1013                 if (!ufs_qcom_is_link_active(hba)) {
1014                         /* disable device ref_clk */
1015                         ufs_qcom_dev_ref_clk_ctrl(host, false);
1016                 }
1017
1018                 vote = host->bus_vote.min_bw_vote;
1019         }
1020
1021         err = ufs_qcom_set_bus_vote(host, vote);
1022         if (err)
1023                 dev_err(hba->dev, "%s: set bus vote failed %d\n",
1024                                 __func__, err);
1025
1026         return err;
1027 }
1028
1029 static int
1030 ufs_qcom_reset_assert(struct reset_controller_dev *rcdev, unsigned long id)
1031 {
1032         struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
1033
1034         /* Currently this code only knows about a single reset. */
1035         WARN_ON(id);
1036         ufs_qcom_assert_reset(host->hba);
1037         /* provide 1ms delay to let the reset pulse propagate. */
1038         usleep_range(1000, 1100);
1039         return 0;
1040 }
1041
1042 static int
1043 ufs_qcom_reset_deassert(struct reset_controller_dev *rcdev, unsigned long id)
1044 {
1045         struct ufs_qcom_host *host = rcdev_to_ufs_host(rcdev);
1046
1047         /* Currently this code only knows about a single reset. */
1048         WARN_ON(id);
1049         ufs_qcom_deassert_reset(host->hba);
1050
1051         /*
1052          * after reset deassertion, phy will need all ref clocks,
1053          * voltage, current to settle down before starting serdes.
1054          */
1055         usleep_range(1000, 1100);
1056         return 0;
1057 }
1058
1059 static const struct reset_control_ops ufs_qcom_reset_ops = {
1060         .assert = ufs_qcom_reset_assert,
1061         .deassert = ufs_qcom_reset_deassert,
1062 };
1063
1064 #define ANDROID_BOOT_DEV_MAX    30
1065 static char android_boot_dev[ANDROID_BOOT_DEV_MAX];
1066
1067 #ifndef MODULE
1068 static int __init get_android_boot_dev(char *str)
1069 {
1070         strlcpy(android_boot_dev, str, ANDROID_BOOT_DEV_MAX);
1071         return 1;
1072 }
1073 __setup("androidboot.bootdevice=", get_android_boot_dev);
1074 #endif
1075
1076 /**
1077  * ufs_qcom_init - bind phy with controller
1078  * @hba: host controller instance
1079  *
1080  * Binds PHY with controller and powers up PHY enabling clocks
1081  * and regulators.
1082  *
1083  * Returns -EPROBE_DEFER if binding fails, returns negative error
1084  * on phy power up failure and returns zero on success.
1085  */
1086 static int ufs_qcom_init(struct ufs_hba *hba)
1087 {
1088         int err;
1089         struct device *dev = hba->dev;
1090         struct platform_device *pdev = to_platform_device(dev);
1091         struct ufs_qcom_host *host;
1092         struct resource *res;
1093
1094         if (strlen(android_boot_dev) && strcmp(android_boot_dev, dev_name(dev)))
1095                 return -ENODEV;
1096
1097         host = devm_kzalloc(dev, sizeof(*host), GFP_KERNEL);
1098         if (!host) {
1099                 err = -ENOMEM;
1100                 dev_err(dev, "%s: no memory for qcom ufs host\n", __func__);
1101                 goto out;
1102         }
1103
1104         /* Make a two way bind between the qcom host and the hba */
1105         host->hba = hba;
1106         ufshcd_set_variant(hba, host);
1107
1108         /* Fire up the reset controller. Failure here is non-fatal. */
1109         host->rcdev.of_node = dev->of_node;
1110         host->rcdev.ops = &ufs_qcom_reset_ops;
1111         host->rcdev.owner = dev->driver->owner;
1112         host->rcdev.nr_resets = 1;
1113         err = devm_reset_controller_register(dev, &host->rcdev);
1114         if (err) {
1115                 dev_warn(dev, "Failed to register reset controller\n");
1116                 err = 0;
1117         }
1118
1119         /*
1120          * voting/devoting device ref_clk source is time consuming hence
1121          * skip devoting it during aggressive clock gating. This clock
1122          * will still be gated off during runtime suspend.
1123          */
1124         host->generic_phy = devm_phy_get(dev, "ufsphy");
1125
1126         if (host->generic_phy == ERR_PTR(-EPROBE_DEFER)) {
1127                 /*
1128                  * UFS driver might be probed before the phy driver does.
1129                  * In that case we would like to return EPROBE_DEFER code.
1130                  */
1131                 err = -EPROBE_DEFER;
1132                 dev_warn(dev, "%s: required phy device. hasn't probed yet. err = %d\n",
1133                         __func__, err);
1134                 goto out_variant_clear;
1135         } else if (IS_ERR(host->generic_phy)) {
1136                 if (has_acpi_companion(dev)) {
1137                         host->generic_phy = NULL;
1138                 } else {
1139                         err = PTR_ERR(host->generic_phy);
1140                         dev_err(dev, "%s: PHY get failed %d\n", __func__, err);
1141                         goto out_variant_clear;
1142                 }
1143         }
1144
1145         host->device_reset = devm_gpiod_get_optional(dev, "reset",
1146                                                      GPIOD_OUT_HIGH);
1147         if (IS_ERR(host->device_reset)) {
1148                 err = PTR_ERR(host->device_reset);
1149                 if (err != -EPROBE_DEFER)
1150                         dev_err(dev, "failed to acquire reset gpio: %d\n", err);
1151                 goto out_variant_clear;
1152         }
1153
1154         err = ufs_qcom_bus_register(host);
1155         if (err)
1156                 goto out_variant_clear;
1157
1158         ufs_qcom_get_controller_revision(hba, &host->hw_ver.major,
1159                 &host->hw_ver.minor, &host->hw_ver.step);
1160
1161         /*
1162          * for newer controllers, device reference clock control bit has
1163          * moved inside UFS controller register address space itself.
1164          */
1165         if (host->hw_ver.major >= 0x02) {
1166                 host->dev_ref_clk_ctrl_mmio = hba->mmio_base + REG_UFS_CFG1;
1167                 host->dev_ref_clk_en_mask = BIT(26);
1168         } else {
1169                 /* "dev_ref_clk_ctrl_mem" is optional resource */
1170                 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1171                 if (res) {
1172                         host->dev_ref_clk_ctrl_mmio =
1173                                         devm_ioremap_resource(dev, res);
1174                         if (IS_ERR(host->dev_ref_clk_ctrl_mmio)) {
1175                                 dev_warn(dev,
1176                                         "%s: could not map dev_ref_clk_ctrl_mmio, err %ld\n",
1177                                         __func__,
1178                                         PTR_ERR(host->dev_ref_clk_ctrl_mmio));
1179                                 host->dev_ref_clk_ctrl_mmio = NULL;
1180                         }
1181                         host->dev_ref_clk_en_mask = BIT(5);
1182                 }
1183         }
1184
1185         err = ufs_qcom_init_lane_clks(host);
1186         if (err)
1187                 goto out_variant_clear;
1188
1189         ufs_qcom_set_caps(hba);
1190         ufs_qcom_advertise_quirks(hba);
1191
1192         ufs_qcom_setup_clocks(hba, true, POST_CHANGE);
1193
1194         if (hba->dev->id < MAX_UFS_QCOM_HOSTS)
1195                 ufs_qcom_hosts[hba->dev->id] = host;
1196
1197         host->dbg_print_en |= UFS_QCOM_DEFAULT_DBG_PRINT_EN;
1198         ufs_qcom_get_default_testbus_cfg(host);
1199         err = ufs_qcom_testbus_config(host);
1200         if (err) {
1201                 dev_warn(dev, "%s: failed to configure the testbus %d\n",
1202                                 __func__, err);
1203                 err = 0;
1204         }
1205
1206         goto out;
1207
1208 out_variant_clear:
1209         ufshcd_set_variant(hba, NULL);
1210 out:
1211         return err;
1212 }
1213
1214 static void ufs_qcom_exit(struct ufs_hba *hba)
1215 {
1216         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1217
1218         ufs_qcom_disable_lane_clks(host);
1219         phy_power_off(host->generic_phy);
1220         phy_exit(host->generic_phy);
1221 }
1222
1223 static int ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(struct ufs_hba *hba,
1224                                                        u32 clk_cycles)
1225 {
1226         int err;
1227         u32 core_clk_ctrl_reg;
1228
1229         if (clk_cycles > DME_VS_CORE_CLK_CTRL_MAX_CORE_CLK_1US_CYCLES_MASK)
1230                 return -EINVAL;
1231
1232         err = ufshcd_dme_get(hba,
1233                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1234                             &core_clk_ctrl_reg);
1235         if (err)
1236                 goto out;
1237
1238         core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_MAX_CORE_CLK_1US_CYCLES_MASK;
1239         core_clk_ctrl_reg |= clk_cycles;
1240
1241         /* Clear CORE_CLK_DIV_EN */
1242         core_clk_ctrl_reg &= ~DME_VS_CORE_CLK_CTRL_CORE_CLK_DIV_EN_BIT;
1243
1244         err = ufshcd_dme_set(hba,
1245                             UIC_ARG_MIB(DME_VS_CORE_CLK_CTRL),
1246                             core_clk_ctrl_reg);
1247 out:
1248         return err;
1249 }
1250
1251 static int ufs_qcom_clk_scale_up_pre_change(struct ufs_hba *hba)
1252 {
1253         /* nothing to do as of now */
1254         return 0;
1255 }
1256
1257 static int ufs_qcom_clk_scale_up_post_change(struct ufs_hba *hba)
1258 {
1259         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1260
1261         if (!ufs_qcom_cap_qunipro(host))
1262                 return 0;
1263
1264         /* set unipro core clock cycles to 150 and clear clock divider */
1265         return ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba, 150);
1266 }
1267
1268 static int ufs_qcom_clk_scale_down_pre_change(struct ufs_hba *hba)
1269 {
1270         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1271         int err;
1272         u32 core_clk_ctrl_reg;
1273
1274         if (!ufs_qcom_cap_qunipro(host))
1275                 return 0;
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         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1296
1297         if (!ufs_qcom_cap_qunipro(host))
1298                 return 0;
1299
1300         /* set unipro core clock cycles to 75 and clear clock divider */
1301         return ufs_qcom_set_dme_vs_core_clk_ctrl_clear_div(hba, 75);
1302 }
1303
1304 static int ufs_qcom_clk_scale_notify(struct ufs_hba *hba,
1305                 bool scale_up, enum ufs_notify_change_status status)
1306 {
1307         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1308         struct ufs_pa_layer_attr *dev_req_params = &host->dev_req_params;
1309         int err = 0;
1310
1311         if (status == PRE_CHANGE) {
1312                 if (scale_up)
1313                         err = ufs_qcom_clk_scale_up_pre_change(hba);
1314                 else
1315                         err = ufs_qcom_clk_scale_down_pre_change(hba);
1316         } else {
1317                 if (scale_up)
1318                         err = ufs_qcom_clk_scale_up_post_change(hba);
1319                 else
1320                         err = ufs_qcom_clk_scale_down_post_change(hba);
1321
1322                 if (err || !dev_req_params)
1323                         goto out;
1324
1325                 ufs_qcom_cfg_timers(hba,
1326                                     dev_req_params->gear_rx,
1327                                     dev_req_params->pwr_rx,
1328                                     dev_req_params->hs_rate,
1329                                     false);
1330                 ufs_qcom_update_bus_bw_vote(host);
1331         }
1332
1333 out:
1334         return err;
1335 }
1336
1337 static void ufs_qcom_print_hw_debug_reg_all(struct ufs_hba *hba,
1338                 void *priv, void (*print_fn)(struct ufs_hba *hba,
1339                 int offset, int num_regs, const char *str, void *priv))
1340 {
1341         u32 reg;
1342         struct ufs_qcom_host *host;
1343
1344         if (unlikely(!hba)) {
1345                 pr_err("%s: hba is NULL\n", __func__);
1346                 return;
1347         }
1348         if (unlikely(!print_fn)) {
1349                 dev_err(hba->dev, "%s: print_fn is NULL\n", __func__);
1350                 return;
1351         }
1352
1353         host = ufshcd_get_variant(hba);
1354         if (!(host->dbg_print_en & UFS_QCOM_DBG_PRINT_REGS_EN))
1355                 return;
1356
1357         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_REG_OCSC);
1358         print_fn(hba, reg, 44, "UFS_UFS_DBG_RD_REG_OCSC ", priv);
1359
1360         reg = ufshcd_readl(hba, REG_UFS_CFG1);
1361         reg |= UTP_DBG_RAMS_EN;
1362         ufshcd_writel(hba, reg, REG_UFS_CFG1);
1363
1364         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_EDTL_RAM);
1365         print_fn(hba, reg, 32, "UFS_UFS_DBG_RD_EDTL_RAM ", priv);
1366
1367         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_DESC_RAM);
1368         print_fn(hba, reg, 128, "UFS_UFS_DBG_RD_DESC_RAM ", priv);
1369
1370         reg = ufs_qcom_get_debug_reg_offset(host, UFS_UFS_DBG_RD_PRDT_RAM);
1371         print_fn(hba, reg, 64, "UFS_UFS_DBG_RD_PRDT_RAM ", priv);
1372
1373         /* clear bit 17 - UTP_DBG_RAMS_EN */
1374         ufshcd_rmwl(hba, UTP_DBG_RAMS_EN, 0, REG_UFS_CFG1);
1375
1376         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UAWM);
1377         print_fn(hba, reg, 4, "UFS_DBG_RD_REG_UAWM ", priv);
1378
1379         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_UARM);
1380         print_fn(hba, reg, 4, "UFS_DBG_RD_REG_UARM ", priv);
1381
1382         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TXUC);
1383         print_fn(hba, reg, 48, "UFS_DBG_RD_REG_TXUC ", priv);
1384
1385         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_RXUC);
1386         print_fn(hba, reg, 27, "UFS_DBG_RD_REG_RXUC ", priv);
1387
1388         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_DFC);
1389         print_fn(hba, reg, 19, "UFS_DBG_RD_REG_DFC ", priv);
1390
1391         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TRLUT);
1392         print_fn(hba, reg, 34, "UFS_DBG_RD_REG_TRLUT ", priv);
1393
1394         reg = ufs_qcom_get_debug_reg_offset(host, UFS_DBG_RD_REG_TMRLUT);
1395         print_fn(hba, reg, 9, "UFS_DBG_RD_REG_TMRLUT ", priv);
1396 }
1397
1398 static void ufs_qcom_enable_test_bus(struct ufs_qcom_host *host)
1399 {
1400         if (host->dbg_print_en & UFS_QCOM_DBG_PRINT_TEST_BUS_EN) {
1401                 ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN,
1402                                 UFS_REG_TEST_BUS_EN, REG_UFS_CFG1);
1403                 ufshcd_rmwl(host->hba, TEST_BUS_EN, TEST_BUS_EN, REG_UFS_CFG1);
1404         } else {
1405                 ufshcd_rmwl(host->hba, UFS_REG_TEST_BUS_EN, 0, REG_UFS_CFG1);
1406                 ufshcd_rmwl(host->hba, TEST_BUS_EN, 0, REG_UFS_CFG1);
1407         }
1408 }
1409
1410 static void ufs_qcom_get_default_testbus_cfg(struct ufs_qcom_host *host)
1411 {
1412         /* provide a legal default configuration */
1413         host->testbus.select_major = TSTBUS_UNIPRO;
1414         host->testbus.select_minor = 37;
1415 }
1416
1417 static bool ufs_qcom_testbus_cfg_is_ok(struct ufs_qcom_host *host)
1418 {
1419         if (host->testbus.select_major >= TSTBUS_MAX) {
1420                 dev_err(host->hba->dev,
1421                         "%s: UFS_CFG1[TEST_BUS_SEL} may not equal 0x%05X\n",
1422                         __func__, host->testbus.select_major);
1423                 return false;
1424         }
1425
1426         return true;
1427 }
1428
1429 int ufs_qcom_testbus_config(struct ufs_qcom_host *host)
1430 {
1431         int reg;
1432         int offset;
1433         u32 mask = TEST_BUS_SUB_SEL_MASK;
1434
1435         if (!host)
1436                 return -EINVAL;
1437
1438         if (!ufs_qcom_testbus_cfg_is_ok(host))
1439                 return -EPERM;
1440
1441         switch (host->testbus.select_major) {
1442         case TSTBUS_UAWM:
1443                 reg = UFS_TEST_BUS_CTRL_0;
1444                 offset = 24;
1445                 break;
1446         case TSTBUS_UARM:
1447                 reg = UFS_TEST_BUS_CTRL_0;
1448                 offset = 16;
1449                 break;
1450         case TSTBUS_TXUC:
1451                 reg = UFS_TEST_BUS_CTRL_0;
1452                 offset = 8;
1453                 break;
1454         case TSTBUS_RXUC:
1455                 reg = UFS_TEST_BUS_CTRL_0;
1456                 offset = 0;
1457                 break;
1458         case TSTBUS_DFC:
1459                 reg = UFS_TEST_BUS_CTRL_1;
1460                 offset = 24;
1461                 break;
1462         case TSTBUS_TRLUT:
1463                 reg = UFS_TEST_BUS_CTRL_1;
1464                 offset = 16;
1465                 break;
1466         case TSTBUS_TMRLUT:
1467                 reg = UFS_TEST_BUS_CTRL_1;
1468                 offset = 8;
1469                 break;
1470         case TSTBUS_OCSC:
1471                 reg = UFS_TEST_BUS_CTRL_1;
1472                 offset = 0;
1473                 break;
1474         case TSTBUS_WRAPPER:
1475                 reg = UFS_TEST_BUS_CTRL_2;
1476                 offset = 16;
1477                 break;
1478         case TSTBUS_COMBINED:
1479                 reg = UFS_TEST_BUS_CTRL_2;
1480                 offset = 8;
1481                 break;
1482         case TSTBUS_UTP_HCI:
1483                 reg = UFS_TEST_BUS_CTRL_2;
1484                 offset = 0;
1485                 break;
1486         case TSTBUS_UNIPRO:
1487                 reg = UFS_UNIPRO_CFG;
1488                 offset = 20;
1489                 mask = 0xFFF;
1490                 break;
1491         /*
1492          * No need for a default case, since
1493          * ufs_qcom_testbus_cfg_is_ok() checks that the configuration
1494          * is legal
1495          */
1496         }
1497         mask <<= offset;
1498         ufshcd_rmwl(host->hba, TEST_BUS_SEL,
1499                     (u32)host->testbus.select_major << 19,
1500                     REG_UFS_CFG1);
1501         ufshcd_rmwl(host->hba, mask,
1502                     (u32)host->testbus.select_minor << offset,
1503                     reg);
1504         ufs_qcom_enable_test_bus(host);
1505         /*
1506          * Make sure the test bus configuration is
1507          * committed before returning.
1508          */
1509         mb();
1510
1511         return 0;
1512 }
1513
1514 static void ufs_qcom_testbus_read(struct ufs_hba *hba)
1515 {
1516         ufshcd_dump_regs(hba, UFS_TEST_BUS, 4, "UFS_TEST_BUS ");
1517 }
1518
1519 static void ufs_qcom_print_unipro_testbus(struct ufs_hba *hba)
1520 {
1521         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1522         u32 *testbus = NULL;
1523         int i, nminor = 256, testbus_len = nminor * sizeof(u32);
1524
1525         testbus = kmalloc(testbus_len, GFP_KERNEL);
1526         if (!testbus)
1527                 return;
1528
1529         host->testbus.select_major = TSTBUS_UNIPRO;
1530         for (i = 0; i < nminor; i++) {
1531                 host->testbus.select_minor = i;
1532                 ufs_qcom_testbus_config(host);
1533                 testbus[i] = ufshcd_readl(hba, UFS_TEST_BUS);
1534         }
1535         print_hex_dump(KERN_ERR, "UNIPRO_TEST_BUS ", DUMP_PREFIX_OFFSET,
1536                         16, 4, testbus, testbus_len, false);
1537         kfree(testbus);
1538 }
1539
1540 static void ufs_qcom_dump_dbg_regs(struct ufs_hba *hba)
1541 {
1542         ufshcd_dump_regs(hba, REG_UFS_SYS1CLK_1US, 16 * 4,
1543                          "HCI Vendor Specific Registers ");
1544
1545         /* sleep a bit intermittently as we are dumping too much data */
1546         ufs_qcom_print_hw_debug_reg_all(hba, NULL, ufs_qcom_dump_regs_wrapper);
1547         udelay(1000);
1548         ufs_qcom_testbus_read(hba);
1549         udelay(1000);
1550         ufs_qcom_print_unipro_testbus(hba);
1551         udelay(1000);
1552 }
1553
1554 /**
1555  * ufs_qcom_device_reset() - toggle the (optional) device reset line
1556  * @hba: per-adapter instance
1557  *
1558  * Toggles the (optional) reset line to reset the attached device.
1559  */
1560 static void ufs_qcom_device_reset(struct ufs_hba *hba)
1561 {
1562         struct ufs_qcom_host *host = ufshcd_get_variant(hba);
1563
1564         /* reset gpio is optional */
1565         if (!host->device_reset)
1566                 return;
1567
1568         /*
1569          * The UFS device shall detect reset pulses of 1us, sleep for 10us to
1570          * be on the safe side.
1571          */
1572         gpiod_set_value_cansleep(host->device_reset, 1);
1573         usleep_range(10, 15);
1574
1575         gpiod_set_value_cansleep(host->device_reset, 0);
1576         usleep_range(10, 15);
1577 }
1578
1579 /**
1580  * struct ufs_hba_qcom_vops - UFS QCOM specific variant operations
1581  *
1582  * The variant operations configure the necessary controller and PHY
1583  * handshake during initialization.
1584  */
1585 static const struct ufs_hba_variant_ops ufs_hba_qcom_vops = {
1586         .name                   = "qcom",
1587         .init                   = ufs_qcom_init,
1588         .exit                   = ufs_qcom_exit,
1589         .get_ufs_hci_version    = ufs_qcom_get_ufs_hci_version,
1590         .clk_scale_notify       = ufs_qcom_clk_scale_notify,
1591         .setup_clocks           = ufs_qcom_setup_clocks,
1592         .hce_enable_notify      = ufs_qcom_hce_enable_notify,
1593         .link_startup_notify    = ufs_qcom_link_startup_notify,
1594         .pwr_change_notify      = ufs_qcom_pwr_change_notify,
1595         .apply_dev_quirks       = ufs_qcom_apply_dev_quirks,
1596         .suspend                = ufs_qcom_suspend,
1597         .resume                 = ufs_qcom_resume,
1598         .dbg_register_dump      = ufs_qcom_dump_dbg_regs,
1599         .device_reset           = ufs_qcom_device_reset,
1600 };
1601
1602 /**
1603  * ufs_qcom_probe - probe routine of the driver
1604  * @pdev: pointer to Platform device handle
1605  *
1606  * Return zero for success and non-zero for failure
1607  */
1608 static int ufs_qcom_probe(struct platform_device *pdev)
1609 {
1610         int err;
1611         struct device *dev = &pdev->dev;
1612
1613         /* Perform generic probe */
1614         err = ufshcd_pltfrm_init(pdev, &ufs_hba_qcom_vops);
1615         if (err)
1616                 dev_err(dev, "ufshcd_pltfrm_init() failed %d\n", err);
1617
1618         return err;
1619 }
1620
1621 /**
1622  * ufs_qcom_remove - set driver_data of the device to NULL
1623  * @pdev: pointer to platform device handle
1624  *
1625  * Always returns 0
1626  */
1627 static int ufs_qcom_remove(struct platform_device *pdev)
1628 {
1629         struct ufs_hba *hba =  platform_get_drvdata(pdev);
1630
1631         pm_runtime_get_sync(&(pdev)->dev);
1632         ufshcd_remove(hba);
1633         return 0;
1634 }
1635
1636 static const struct of_device_id ufs_qcom_of_match[] = {
1637         { .compatible = "qcom,ufshc"},
1638         {},
1639 };
1640 MODULE_DEVICE_TABLE(of, ufs_qcom_of_match);
1641
1642 #ifdef CONFIG_ACPI
1643 static const struct acpi_device_id ufs_qcom_acpi_match[] = {
1644         { "QCOM24A5" },
1645         { },
1646 };
1647 MODULE_DEVICE_TABLE(acpi, ufs_qcom_acpi_match);
1648 #endif
1649
1650 static const struct dev_pm_ops ufs_qcom_pm_ops = {
1651         .suspend        = ufshcd_pltfrm_suspend,
1652         .resume         = ufshcd_pltfrm_resume,
1653         .runtime_suspend = ufshcd_pltfrm_runtime_suspend,
1654         .runtime_resume  = ufshcd_pltfrm_runtime_resume,
1655         .runtime_idle    = ufshcd_pltfrm_runtime_idle,
1656 };
1657
1658 static struct platform_driver ufs_qcom_pltform = {
1659         .probe  = ufs_qcom_probe,
1660         .remove = ufs_qcom_remove,
1661         .shutdown = ufshcd_pltfrm_shutdown,
1662         .driver = {
1663                 .name   = "ufshcd-qcom",
1664                 .pm     = &ufs_qcom_pm_ops,
1665                 .of_match_table = of_match_ptr(ufs_qcom_of_match),
1666                 .acpi_match_table = ACPI_PTR(ufs_qcom_acpi_match),
1667         },
1668 };
1669 module_platform_driver(ufs_qcom_pltform);
1670
1671 MODULE_LICENSE("GPL v2");