drivers/scsi/ufs/ufshcd-pltfrm.c

   1 /*
   2  * Universal Flash Storage Host controller Platform bus based glue driver
   3  *
   4  * This code is based on drivers/scsi/ufs/ufshcd-pltfrm.c
   5  * Copyright (C) 2011-2013 Samsung India Software Operations
   6  *
   7  * Authors:
   8  *      Santosh Yaraganavi <santosh.sy@samsung.com>
   9  *      Vinayak Holikatti <h.vinayak@samsung.com>
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  * See the COPYING file in the top-level directory or visit
  16  * <http://www.gnu.org/licenses/gpl-2.0.html>
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * This program is provided "AS IS" and "WITH ALL FAULTS" and
  24  * without warranty of any kind. You are solely responsible for
  25  * determining the appropriateness of using and distributing
  26  * the program and assume all risks associated with your exercise
  27  * of rights with respect to the program, including but not limited
  28  * to infringement of third party rights, the risks and costs of
  29  * program errors, damage to or loss of data, programs or equipment,
  30  * and unavailability or interruption of operations. Under no
  31  * circumstances will the contributor of this Program be liable for
  32  * any damages of any kind arising from your use or distribution of
  33  * this program.
  34  */
  35
  36 #include <linux/platform_device.h>
  37 #include <linux/pm_runtime.h>
  38 #include <linux/of.h>
  39
  40 #include "ufshcd.h"
  41 #include "ufshcd-pltfrm.h"
  42 #include "unipro.h"
  43
  44 #define UFSHCD_DEFAULT_LANES_PER_DIRECTION              2
  45
  46 static int ufshcd_parse_clock_info(struct ufs_hba *hba)
  47 {
  48         int ret = 0;
  49         int cnt;
  50         int i;
  51         struct device *dev = hba->dev;
  52         struct device_node *np = dev->of_node;
  53         char *name;
  54         u32 *clkfreq = NULL;
  55         struct ufs_clk_info *clki;
  56         int len = 0;
  57         size_t sz = 0;
  58
  59         if (!np)
  60                 goto out;
  61
  62         cnt = of_property_count_strings(np, "clock-names");
  63         if (!cnt || (cnt == -EINVAL)) {
  64                 dev_info(dev, "%s: Unable to find clocks, assuming enabled\n",
  65                                 __func__);
  66         } else if (cnt < 0) {
  67                 dev_err(dev, "%s: count clock strings failed, err %d\n",
  68                                 __func__, cnt);
  69                 ret = cnt;
  70         }
  71
  72         if (cnt <= 0)
  73                 goto out;
  74
  75         if (!of_get_property(np, "freq-table-hz", &len)) {
  76                 dev_info(dev, "freq-table-hz property not specified\n");
  77                 goto out;
  78         }
  79
  80         if (len <= 0)
  81                 goto out;
  82
  83         sz = len / sizeof(*clkfreq);
  84         if (sz != 2 * cnt) {
  85                 dev_err(dev, "%s len mismatch\n", "freq-table-hz");
  86                 ret = -EINVAL;
  87                 goto out;
  88         }
  89
  90         clkfreq = devm_kcalloc(dev, sz, sizeof(*clkfreq),
  91                                GFP_KERNEL);
  92         if (!clkfreq) {
  93                 ret = -ENOMEM;
  94                 goto out;
  95         }
  96
  97         ret = of_property_read_u32_array(np, "freq-table-hz",
  98                         clkfreq, sz);
  99         if (ret && (ret != -EINVAL)) {
 100                 dev_err(dev, "%s: error reading array %d\n",
 101                                 "freq-table-hz", ret);
 102                 return ret;
 103         }
 104
 105         for (i = 0; i < sz; i += 2) {
 106                 ret = of_property_read_string_index(np,
 107                                 "clock-names", i/2, (const char **)&name);
 108                 if (ret)
 109                         goto out;
 110
 111                 clki = devm_kzalloc(dev, sizeof(*clki), GFP_KERNEL);
 112                 if (!clki) {
 113                         ret = -ENOMEM;
 114                         goto out;
 115                 }
 116
 117                 clki->min_freq = clkfreq[i];
 118                 clki->max_freq = clkfreq[i+1];
 119                 clki->name = kstrdup(name, GFP_KERNEL);
 120                 dev_dbg(dev, "%s: min %u max %u name %s\n", "freq-table-hz",
 121                                 clki->min_freq, clki->max_freq, clki->name);
 122                 list_add_tail(&clki->list, &hba->clk_list_head);
 123         }
 124 out:
 125         return ret;
 126 }
 127
 128 #define MAX_PROP_SIZE 32
 129 static int ufshcd_populate_vreg(struct device *dev, const char *name,
 130                 struct ufs_vreg **out_vreg)
 131 {
 132         int ret = 0;
 133         char prop_name[MAX_PROP_SIZE];
 134         struct ufs_vreg *vreg = NULL;
 135         struct device_node *np = dev->of_node;
 136
 137         if (!np) {
 138                 dev_err(dev, "%s: non DT initialization\n", __func__);
 139                 goto out;
 140         }
 141
 142         snprintf(prop_name, MAX_PROP_SIZE, "%s-supply", name);
 143         if (!of_parse_phandle(np, prop_name, 0)) {
 144                 dev_info(dev, "%s: Unable to find %s regulator, assuming enabled\n",
 145                                 __func__, prop_name);
 146                 goto out;
 147         }
 148
 149         vreg = devm_kzalloc(dev, sizeof(*vreg), GFP_KERNEL);
 150         if (!vreg)
 151                 return -ENOMEM;
 152
 153         vreg->name = kstrdup(name, GFP_KERNEL);
 154
 155         snprintf(prop_name, MAX_PROP_SIZE, "%s-max-microamp", name);
 156         if (of_property_read_u32(np, prop_name, &vreg->max_uA)) {
 157                 dev_info(dev, "%s: unable to find %s\n", __func__, prop_name);
 158                 vreg->max_uA = 0;
 159         }
 160
 161         if (!strcmp(name, "vcc")) {
 162                 if (of_property_read_bool(np, "vcc-supply-1p8")) {
 163                         vreg->min_uV = UFS_VREG_VCC_1P8_MIN_UV;
 164                         vreg->max_uV = UFS_VREG_VCC_1P8_MAX_UV;
 165                 } else {
 166                         vreg->min_uV = UFS_VREG_VCC_MIN_UV;
 167                         vreg->max_uV = UFS_VREG_VCC_MAX_UV;
 168                 }
 169         } else if (!strcmp(name, "vccq")) {
 170                 vreg->min_uV = UFS_VREG_VCCQ_MIN_UV;
 171                 vreg->max_uV = UFS_VREG_VCCQ_MAX_UV;
 172         } else if (!strcmp(name, "vccq2")) {
 173                 vreg->min_uV = UFS_VREG_VCCQ2_MIN_UV;
 174                 vreg->max_uV = UFS_VREG_VCCQ2_MAX_UV;
 175         }
 176
 177         goto out;
 178
 179 out:
 180         if (!ret)
 181                 *out_vreg = vreg;
 182         return ret;
 183 }
 184
 185 /**
 186  * ufshcd_parse_regulator_info - get regulator info from device tree
 187  * @hba: per adapter instance
 188  *
 189  * Get regulator info from device tree for vcc, vccq, vccq2 power supplies.
 190  * If any of the supplies are not defined it is assumed that they are always-on
 191  * and hence return zero. If the property is defined but parsing is failed
 192  * then return corresponding error.
 193  */
 194 static int ufshcd_parse_regulator_info(struct ufs_hba *hba)
 195 {
 196         int err;
 197         struct device *dev = hba->dev;
 198         struct ufs_vreg_info *info = &hba->vreg_info;
 199
 200         err = ufshcd_populate_vreg(dev, "vdd-hba", &info->vdd_hba);
 201         if (err)
 202                 goto out;
 203
 204         err = ufshcd_populate_vreg(dev, "vcc", &info->vcc);
 205         if (err)
 206                 goto out;
 207
 208         err = ufshcd_populate_vreg(dev, "vccq", &info->vccq);
 209         if (err)
 210                 goto out;
 211
 212         err = ufshcd_populate_vreg(dev, "vccq2", &info->vccq2);
 213 out:
 214         return err;
 215 }
 216
 217 #ifdef CONFIG_PM
 218 /**
 219  * ufshcd_pltfrm_suspend - suspend power management function
 220  * @dev: pointer to device handle
 221  *
 222  * Returns 0 if successful
 223  * Returns non-zero otherwise
 224  */
 225 int ufshcd_pltfrm_suspend(struct device *dev)
 226 {
 227         return ufshcd_system_suspend(dev_get_drvdata(dev));
 228 }
 229 EXPORT_SYMBOL_GPL(ufshcd_pltfrm_suspend);
 230
 231 /**
 232  * ufshcd_pltfrm_resume - resume power management function
 233  * @dev: pointer to device handle
 234  *
 235  * Returns 0 if successful
 236  * Returns non-zero otherwise
 237  */
 238 int ufshcd_pltfrm_resume(struct device *dev)
 239 {
 240         return ufshcd_system_resume(dev_get_drvdata(dev));
 241 }
 242 EXPORT_SYMBOL_GPL(ufshcd_pltfrm_resume);
 243
 244 int ufshcd_pltfrm_runtime_suspend(struct device *dev)
 245 {
 246         return ufshcd_runtime_suspend(dev_get_drvdata(dev));
 247 }
 248 EXPORT_SYMBOL_GPL(ufshcd_pltfrm_runtime_suspend);
 249
 250 int ufshcd_pltfrm_runtime_resume(struct device *dev)
 251 {
 252         return ufshcd_runtime_resume(dev_get_drvdata(dev));
 253 }
 254 EXPORT_SYMBOL_GPL(ufshcd_pltfrm_runtime_resume);
 255
 256 int ufshcd_pltfrm_runtime_idle(struct device *dev)
 257 {
 258         return ufshcd_runtime_idle(dev_get_drvdata(dev));
 259 }
 260 EXPORT_SYMBOL_GPL(ufshcd_pltfrm_runtime_idle);
 261
 262 #endif /* CONFIG_PM */
 263
 264 void ufshcd_pltfrm_shutdown(struct platform_device *pdev)
 265 {
 266         ufshcd_shutdown((struct ufs_hba *)platform_get_drvdata(pdev));
 267 }
 268 EXPORT_SYMBOL_GPL(ufshcd_pltfrm_shutdown);
 269
 270 static void ufshcd_init_lanes_per_dir(struct ufs_hba *hba)
 271 {
 272         struct device *dev = hba->dev;
 273         int ret;
 274
 275         ret = of_property_read_u32(dev->of_node, "lanes-per-direction",
 276                 &hba->lanes_per_direction);
 277         if (ret) {
 278                 dev_dbg(hba->dev,
 279                         "%s: failed to read lanes-per-direction, ret=%d\n",
 280                         __func__, ret);
 281                 hba->lanes_per_direction = UFSHCD_DEFAULT_LANES_PER_DIRECTION;
 282         }
 283 }
 284
 285 /**
 286  * ufshcd_get_pwr_dev_param - get finally agreed attributes for
 287  *                            power mode change
 288  * @pltfrm_param: pointer to platform parameters
 289  * @dev_max: pointer to device attributes
 290  * @agreed_pwr: returned agreed attributes
 291  *
 292  * Returns 0 on success, non-zero value on failure
 293  */
 294 int ufshcd_get_pwr_dev_param(struct ufs_dev_params *pltfrm_param,
 295                              struct ufs_pa_layer_attr *dev_max,
 296                              struct ufs_pa_layer_attr *agreed_pwr)
 297 {
 298         int min_pltfrm_gear;
 299         int min_dev_gear;
 300         bool is_dev_sup_hs = false;
 301         bool is_pltfrm_max_hs = false;
 302
 303         if (dev_max->pwr_rx == FAST_MODE)
 304                 is_dev_sup_hs = true;
 305
 306         if (pltfrm_param->desired_working_mode == UFS_HS_MODE) {
 307                 is_pltfrm_max_hs = true;
 308                 min_pltfrm_gear = min_t(u32, pltfrm_param->hs_rx_gear,
 309                                         pltfrm_param->hs_tx_gear);
 310         } else {
 311                 min_pltfrm_gear = min_t(u32, pltfrm_param->pwm_rx_gear,
 312                                         pltfrm_param->pwm_tx_gear);
 313         }
 314
 315         /*
 316          * device doesn't support HS but
 317          * pltfrm_param->desired_working_mode is HS,
 318          * thus device and pltfrm_param don't agree
 319          */
 320         if (!is_dev_sup_hs && is_pltfrm_max_hs) {
 321                 pr_info("%s: device doesn't support HS\n",
 322                         __func__);
 323                 return -ENOTSUPP;
 324         } else if (is_dev_sup_hs && is_pltfrm_max_hs) {
 325                 /*
 326                  * since device supports HS, it supports FAST_MODE.
 327                  * since pltfrm_param->desired_working_mode is also HS
 328                  * then final decision (FAST/FASTAUTO) is done according
 329                  * to pltfrm_params as it is the restricting factor
 330                  */
 331                 agreed_pwr->pwr_rx = pltfrm_param->rx_pwr_hs;
 332                 agreed_pwr->pwr_tx = agreed_pwr->pwr_rx;
 333         } else {
 334                 /*
 335                  * here pltfrm_param->desired_working_mode is PWM.
 336                  * it doesn't matter whether device supports HS or PWM,
 337                  * in both cases pltfrm_param->desired_working_mode will
 338                  * determine the mode
 339                  */
 340                 agreed_pwr->pwr_rx = pltfrm_param->rx_pwr_pwm;
 341                 agreed_pwr->pwr_tx = agreed_pwr->pwr_rx;
 342         }
 343
 344         /*
 345          * we would like tx to work in the minimum number of lanes
 346          * between device capability and vendor preferences.
 347          * the same decision will be made for rx
 348          */
 349         agreed_pwr->lane_tx = min_t(u32, dev_max->lane_tx,
 350                                     pltfrm_param->tx_lanes);
 351         agreed_pwr->lane_rx = min_t(u32, dev_max->lane_rx,
 352                                     pltfrm_param->rx_lanes);
 353
 354         /* device maximum gear is the minimum between device rx and tx gears */
 355         min_dev_gear = min_t(u32, dev_max->gear_rx, dev_max->gear_tx);
 356
 357         /*
 358          * if both device capabilities and vendor pre-defined preferences are
 359          * both HS or both PWM then set the minimum gear to be the chosen
 360          * working gear.
 361          * if one is PWM and one is HS then the one that is PWM get to decide
 362          * what is the gear, as it is the one that also decided previously what
 363          * pwr the device will be configured to.
 364          */
 365         if ((is_dev_sup_hs && is_pltfrm_max_hs) ||
 366             (!is_dev_sup_hs && !is_pltfrm_max_hs)) {
 367                 agreed_pwr->gear_rx =
 368                         min_t(u32, min_dev_gear, min_pltfrm_gear);
 369         } else if (!is_dev_sup_hs) {
 370                 agreed_pwr->gear_rx = min_dev_gear;
 371         } else {
 372                 agreed_pwr->gear_rx = min_pltfrm_gear;
 373         }
 374         agreed_pwr->gear_tx = agreed_pwr->gear_rx;
 375
 376         agreed_pwr->hs_rate = pltfrm_param->hs_rate;
 377
 378         return 0;
 379 }
 380 EXPORT_SYMBOL_GPL(ufshcd_get_pwr_dev_param);
 381
 382 /**
 383  * ufshcd_pltfrm_init - probe routine of the driver
 384  * @pdev: pointer to Platform device handle
 385  * @vops: pointer to variant ops
 386  *
 387  * Returns 0 on success, non-zero value on failure
 388  */
 389 int ufshcd_pltfrm_init(struct platform_device *pdev,
 390                        const struct ufs_hba_variant_ops *vops)
 391 {
 392         struct ufs_hba *hba;
 393         void __iomem *mmio_base;
 394         struct resource *mem_res;
 395         int irq, err;
 396         struct device *dev = &pdev->dev;
 397
 398         mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 399         mmio_base = devm_ioremap_resource(dev, mem_res);
 400         if (IS_ERR(mmio_base)) {
 401                 err = PTR_ERR(mmio_base);
 402                 goto out;
 403         }
 404
 405         irq = platform_get_irq(pdev, 0);
 406         if (irq < 0) {
 407                 dev_err(dev, "IRQ resource not available\n");
 408                 err = -ENODEV;
 409                 goto out;
 410         }
 411
 412         err = ufshcd_alloc_host(dev, &hba);
 413         if (err) {
 414                 dev_err(&pdev->dev, "Allocation failed\n");
 415                 goto out;
 416         }
 417
 418         hba->vops = vops;
 419
 420         err = ufshcd_parse_clock_info(hba);
 421         if (err) {
 422                 dev_err(&pdev->dev, "%s: clock parse failed %d\n",
 423                                 __func__, err);
 424                 goto dealloc_host;
 425         }
 426         err = ufshcd_parse_regulator_info(hba);
 427         if (err) {
 428                 dev_err(&pdev->dev, "%s: regulator init failed %d\n",
 429                                 __func__, err);
 430                 goto dealloc_host;
 431         }
 432
 433         ufshcd_init_lanes_per_dir(hba);
 434
 435         err = ufshcd_init(hba, mmio_base, irq);
 436         if (err) {
 437                 dev_err(dev, "Initialization failed\n");
 438                 goto dealloc_host;
 439         }
 440
 441         platform_set_drvdata(pdev, hba);
 442
 443         pm_runtime_set_active(&pdev->dev);
 444         pm_runtime_enable(&pdev->dev);
 445
 446         return 0;
 447
 448 dealloc_host:
 449         ufshcd_dealloc_host(hba);
 450 out:
 451         return err;
 452 }
 453 EXPORT_SYMBOL_GPL(ufshcd_pltfrm_init);
 454
 455 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
 456 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
 457 MODULE_DESCRIPTION("UFS host controller Platform bus based glue driver");
 458 MODULE_LICENSE("GPL");
 459 MODULE_VERSION(UFSHCD_DRIVER_VERSION);