drivers/mmc/host/sdhci-of-at91.c

   1 /*
   2  * Atmel SDMMC controller driver.
   3  *
   4  * Copyright (C) 2015 Atmel,
   5  *               2015 Ludovic Desroches <ludovic.desroches@atmel.com>
   6  *
   7  * This software is licensed under the terms of the GNU General Public
   8  * License version 2, as published by the Free Software Foundation, and
   9  * may be copied, distributed, and modified under those terms.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  */
  16
  17 #include <linux/clk.h>
  18 #include <linux/delay.h>
  19 #include <linux/err.h>
  20 #include <linux/io.h>
  21 #include <linux/kernel.h>
  22 #include <linux/mmc/host.h>
  23 #include <linux/mmc/slot-gpio.h>
  24 #include <linux/module.h>
  25 #include <linux/of.h>
  26 #include <linux/of_device.h>
  27 #include <linux/pm.h>
  28 #include <linux/pm_runtime.h>
  29
  30 #include "sdhci-pltfm.h"
  31
  32 #define SDMMC_MC1R      0x204
  33 #define         SDMMC_MC1R_DDR          BIT(3)
  34 #define         SDMMC_MC1R_FCD          BIT(7)
  35 #define SDMMC_CACR      0x230
  36 #define         SDMMC_CACR_CAPWREN      BIT(0)
  37 #define         SDMMC_CACR_KEY          (0x46 << 8)
  38
  39 #define SDHCI_AT91_PRESET_COMMON_CONF   0x400 /* drv type B, programmable clock mode */
  40
  41 struct sdhci_at91_priv {
  42         struct clk *hclock;
  43         struct clk *gck;
  44         struct clk *mainck;
  45         bool restore_needed;
  46 };
  47
  48 static void sdhci_at91_set_force_card_detect(struct sdhci_host *host)
  49 {
  50         u8 mc1r;
  51
  52         mc1r = readb(host->ioaddr + SDMMC_MC1R);
  53         mc1r |= SDMMC_MC1R_FCD;
  54         writeb(mc1r, host->ioaddr + SDMMC_MC1R);
  55 }
  56
  57 static void sdhci_at91_set_clock(struct sdhci_host *host, unsigned int clock)
  58 {
  59         u16 clk;
  60         unsigned long timeout;
  61
  62         host->mmc->actual_clock = 0;
  63
  64         /*
  65          * There is no requirement to disable the internal clock before
  66          * changing the SD clock configuration. Moreover, disabling the
  67          * internal clock, changing the configuration and re-enabling the
  68          * internal clock causes some bugs. It can prevent to get the internal
  69          * clock stable flag ready and an unexpected switch to the base clock
  70          * when using presets.
  71          */
  72         clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL);
  73         clk &= SDHCI_CLOCK_INT_EN;
  74         sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
  75
  76         if (clock == 0)
  77                 return;
  78
  79         clk = sdhci_calc_clk(host, clock, &host->mmc->actual_clock);
  80
  81         clk |= SDHCI_CLOCK_INT_EN;
  82         sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
  83
  84         /* Wait max 20 ms */
  85         timeout = 20;
  86         while (!((clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL))
  87                 & SDHCI_CLOCK_INT_STABLE)) {
  88                 if (timeout == 0) {
  89                         pr_err("%s: Internal clock never stabilised.\n",
  90                                mmc_hostname(host->mmc));
  91                         return;
  92                 }
  93                 timeout--;
  94                 mdelay(1);
  95         }
  96
  97         clk |= SDHCI_CLOCK_CARD_EN;
  98         sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
  99 }
 100
 101 /*
 102  * In this specific implementation of the SDHCI controller, the power register
 103  * needs to have a valid voltage set even when the power supply is managed by
 104  * an external regulator.
 105  */
 106 static void sdhci_at91_set_power(struct sdhci_host *host, unsigned char mode,
 107                      unsigned short vdd)
 108 {
 109         if (!IS_ERR(host->mmc->supply.vmmc)) {
 110                 struct mmc_host *mmc = host->mmc;
 111
 112                 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd);
 113         }
 114         sdhci_set_power_noreg(host, mode, vdd);
 115 }
 116
 117 static void sdhci_at91_set_uhs_signaling(struct sdhci_host *host,
 118                                          unsigned int timing)
 119 {
 120         if (timing == MMC_TIMING_MMC_DDR52)
 121                 sdhci_writeb(host, SDMMC_MC1R_DDR, SDMMC_MC1R);
 122         sdhci_set_uhs_signaling(host, timing);
 123 }
 124
 125 static void sdhci_at91_reset(struct sdhci_host *host, u8 mask)
 126 {
 127         sdhci_reset(host, mask);
 128
 129         if ((host->mmc->caps & MMC_CAP_NONREMOVABLE)
 130             || mmc_gpio_get_cd(host->mmc) >= 0)
 131                 sdhci_at91_set_force_card_detect(host);
 132 }
 133
 134 static const struct sdhci_ops sdhci_at91_sama5d2_ops = {
 135         .set_clock              = sdhci_at91_set_clock,
 136         .set_bus_width          = sdhci_set_bus_width,
 137         .reset                  = sdhci_at91_reset,
 138         .set_uhs_signaling      = sdhci_at91_set_uhs_signaling,
 139         .set_power              = sdhci_at91_set_power,
 140 };
 141
 142 static const struct sdhci_pltfm_data soc_data_sama5d2 = {
 143         .ops = &sdhci_at91_sama5d2_ops,
 144 };
 145
 146 static const struct of_device_id sdhci_at91_dt_match[] = {
 147         { .compatible = "atmel,sama5d2-sdhci", .data = &soc_data_sama5d2 },
 148         {}
 149 };
 150 MODULE_DEVICE_TABLE(of, sdhci_at91_dt_match);
 151
 152 static int sdhci_at91_set_clks_presets(struct device *dev)
 153 {
 154         struct sdhci_host *host = dev_get_drvdata(dev);
 155         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 156         struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
 157         int ret;
 158         unsigned int                    caps0, caps1;
 159         unsigned int                    clk_base, clk_mul;
 160         unsigned int                    gck_rate, real_gck_rate;
 161         unsigned int                    preset_div;
 162
 163         /*
 164          * The mult clock is provided by as a generated clock by the PMC
 165          * controller. In order to set the rate of gck, we have to get the
 166          * base clock rate and the clock mult from capabilities.
 167          */
 168         clk_prepare_enable(priv->hclock);
 169         caps0 = readl(host->ioaddr + SDHCI_CAPABILITIES);
 170         caps1 = readl(host->ioaddr + SDHCI_CAPABILITIES_1);
 171         clk_base = (caps0 & SDHCI_CLOCK_V3_BASE_MASK) >> SDHCI_CLOCK_BASE_SHIFT;
 172         clk_mul = (caps1 & SDHCI_CLOCK_MUL_MASK) >> SDHCI_CLOCK_MUL_SHIFT;
 173         gck_rate = clk_base * 1000000 * (clk_mul + 1);
 174         ret = clk_set_rate(priv->gck, gck_rate);
 175         if (ret < 0) {
 176                 dev_err(dev, "failed to set gck");
 177                 clk_disable_unprepare(priv->hclock);
 178                 return ret;
 179         }
 180         /*
 181          * We need to check if we have the requested rate for gck because in
 182          * some cases this rate could be not supported. If it happens, the rate
 183          * is the closest one gck can provide. We have to update the value
 184          * of clk mul.
 185          */
 186         real_gck_rate = clk_get_rate(priv->gck);
 187         if (real_gck_rate != gck_rate) {
 188                 clk_mul = real_gck_rate / (clk_base * 1000000) - 1;
 189                 caps1 &= (~SDHCI_CLOCK_MUL_MASK);
 190                 caps1 |= ((clk_mul << SDHCI_CLOCK_MUL_SHIFT) &
 191                           SDHCI_CLOCK_MUL_MASK);
 192                 /* Set capabilities in r/w mode. */
 193                 writel(SDMMC_CACR_KEY | SDMMC_CACR_CAPWREN,
 194                        host->ioaddr + SDMMC_CACR);
 195                 writel(caps1, host->ioaddr + SDHCI_CAPABILITIES_1);
 196                 /* Set capabilities in ro mode. */
 197                 writel(0, host->ioaddr + SDMMC_CACR);
 198                 dev_info(dev, "update clk mul to %u as gck rate is %u Hz\n",
 199                          clk_mul, real_gck_rate);
 200         }
 201
 202         /*
 203          * We have to set preset values because it depends on the clk_mul
 204          * value. Moreover, SDR104 is supported in a degraded mode since the
 205          * maximum sd clock value is 120 MHz instead of 208 MHz. For that
 206          * reason, we need to use presets to support SDR104.
 207          */
 208         preset_div = DIV_ROUND_UP(real_gck_rate, 24000000) - 1;
 209         writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
 210                host->ioaddr + SDHCI_PRESET_FOR_SDR12);
 211         preset_div = DIV_ROUND_UP(real_gck_rate, 50000000) - 1;
 212         writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
 213                host->ioaddr + SDHCI_PRESET_FOR_SDR25);
 214         preset_div = DIV_ROUND_UP(real_gck_rate, 100000000) - 1;
 215         writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
 216                host->ioaddr + SDHCI_PRESET_FOR_SDR50);
 217         preset_div = DIV_ROUND_UP(real_gck_rate, 120000000) - 1;
 218         writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
 219                host->ioaddr + SDHCI_PRESET_FOR_SDR104);
 220         preset_div = DIV_ROUND_UP(real_gck_rate, 50000000) - 1;
 221         writew(SDHCI_AT91_PRESET_COMMON_CONF | preset_div,
 222                host->ioaddr + SDHCI_PRESET_FOR_DDR50);
 223
 224         clk_prepare_enable(priv->mainck);
 225         clk_prepare_enable(priv->gck);
 226
 227         return 0;
 228 }
 229
 230 #ifdef CONFIG_PM_SLEEP
 231 static int sdhci_at91_suspend(struct device *dev)
 232 {
 233         struct sdhci_host *host = dev_get_drvdata(dev);
 234         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 235         struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
 236         int ret;
 237
 238         ret = pm_runtime_force_suspend(dev);
 239
 240         priv->restore_needed = true;
 241
 242         return ret;
 243 }
 244 #endif /* CONFIG_PM_SLEEP */
 245
 246 #ifdef CONFIG_PM
 247 static int sdhci_at91_runtime_suspend(struct device *dev)
 248 {
 249         struct sdhci_host *host = dev_get_drvdata(dev);
 250         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 251         struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
 252         int ret;
 253
 254         ret = sdhci_runtime_suspend_host(host);
 255
 256         if (host->tuning_mode != SDHCI_TUNING_MODE_3)
 257                 mmc_retune_needed(host->mmc);
 258
 259         clk_disable_unprepare(priv->gck);
 260         clk_disable_unprepare(priv->hclock);
 261         clk_disable_unprepare(priv->mainck);
 262
 263         return ret;
 264 }
 265
 266 static int sdhci_at91_runtime_resume(struct device *dev)
 267 {
 268         struct sdhci_host *host = dev_get_drvdata(dev);
 269         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 270         struct sdhci_at91_priv *priv = sdhci_pltfm_priv(pltfm_host);
 271         int ret;
 272
 273         if (priv->restore_needed) {
 274                 ret = sdhci_at91_set_clks_presets(dev);
 275                 if (ret)
 276                         return ret;
 277
 278                 priv->restore_needed = false;
 279                 goto out;
 280         }
 281
 282         ret = clk_prepare_enable(priv->mainck);
 283         if (ret) {
 284                 dev_err(dev, "can't enable mainck\n");
 285                 return ret;
 286         }
 287
 288         ret = clk_prepare_enable(priv->hclock);
 289         if (ret) {
 290                 dev_err(dev, "can't enable hclock\n");
 291                 return ret;
 292         }
 293
 294         ret = clk_prepare_enable(priv->gck);
 295         if (ret) {
 296                 dev_err(dev, "can't enable gck\n");
 297                 return ret;
 298         }
 299
 300 out:
 301         return sdhci_runtime_resume_host(host);
 302 }
 303 #endif /* CONFIG_PM */
 304
 305 static const struct dev_pm_ops sdhci_at91_dev_pm_ops = {
 306         SET_SYSTEM_SLEEP_PM_OPS(sdhci_at91_suspend, pm_runtime_force_resume)
 307         SET_RUNTIME_PM_OPS(sdhci_at91_runtime_suspend,
 308                            sdhci_at91_runtime_resume,
 309                            NULL)
 310 };
 311
 312 static int sdhci_at91_probe(struct platform_device *pdev)
 313 {
 314         const struct of_device_id       *match;
 315         const struct sdhci_pltfm_data   *soc_data;
 316         struct sdhci_host               *host;
 317         struct sdhci_pltfm_host         *pltfm_host;
 318         struct sdhci_at91_priv          *priv;
 319         int                             ret;
 320
 321         match = of_match_device(sdhci_at91_dt_match, &pdev->dev);
 322         if (!match)
 323                 return -EINVAL;
 324         soc_data = match->data;
 325
 326         host = sdhci_pltfm_init(pdev, soc_data, sizeof(*priv));
 327         if (IS_ERR(host))
 328                 return PTR_ERR(host);
 329
 330         pltfm_host = sdhci_priv(host);
 331         priv = sdhci_pltfm_priv(pltfm_host);
 332
 333         priv->mainck = devm_clk_get(&pdev->dev, "baseclk");
 334         if (IS_ERR(priv->mainck)) {
 335                 dev_err(&pdev->dev, "failed to get baseclk\n");
 336                 ret = PTR_ERR(priv->mainck);
 337                 goto sdhci_pltfm_free;
 338         }
 339
 340         priv->hclock = devm_clk_get(&pdev->dev, "hclock");
 341         if (IS_ERR(priv->hclock)) {
 342                 dev_err(&pdev->dev, "failed to get hclock\n");
 343                 ret = PTR_ERR(priv->hclock);
 344                 goto sdhci_pltfm_free;
 345         }
 346
 347         priv->gck = devm_clk_get(&pdev->dev, "multclk");
 348         if (IS_ERR(priv->gck)) {
 349                 dev_err(&pdev->dev, "failed to get multclk\n");
 350                 ret = PTR_ERR(priv->gck);
 351                 goto sdhci_pltfm_free;
 352         }
 353
 354         ret = sdhci_at91_set_clks_presets(&pdev->dev);
 355         if (ret)
 356                 goto sdhci_pltfm_free;
 357
 358         priv->restore_needed = false;
 359
 360         ret = mmc_of_parse(host->mmc);
 361         if (ret)
 362                 goto clocks_disable_unprepare;
 363
 364         sdhci_get_of_property(pdev);
 365
 366         pm_runtime_get_noresume(&pdev->dev);
 367         pm_runtime_set_active(&pdev->dev);
 368         pm_runtime_enable(&pdev->dev);
 369         pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
 370         pm_runtime_use_autosuspend(&pdev->dev);
 371
 372         /* HS200 is broken at this moment */
 373         host->quirks2 |= SDHCI_QUIRK2_BROKEN_HS200;
 374
 375         ret = sdhci_add_host(host);
 376         if (ret)
 377                 goto pm_runtime_disable;
 378
 379         /*
 380          * When calling sdhci_runtime_suspend_host(), the sdhci layer makes
 381          * the assumption that all the clocks of the controller are disabled.
 382          * It means we can't get irq from it when it is runtime suspended.
 383          * For that reason, it is not planned to wake-up on a card detect irq
 384          * from the controller.
 385          * If we want to use runtime PM and to be able to wake-up on card
 386          * insertion, we have to use a GPIO for the card detection or we can
 387          * use polling. Be aware that using polling will resume/suspend the
 388          * controller between each attempt.
 389          * Disable SDHCI_QUIRK_BROKEN_CARD_DETECTION to be sure nobody tries
 390          * to enable polling via device tree with broken-cd property.
 391          */
 392         if (mmc_card_is_removable(host->mmc) &&
 393             mmc_gpio_get_cd(host->mmc) < 0) {
 394                 host->mmc->caps |= MMC_CAP_NEEDS_POLL;
 395                 host->quirks &= ~SDHCI_QUIRK_BROKEN_CARD_DETECTION;
 396         }
 397
 398         /*
 399          * If the device attached to the MMC bus is not removable, it is safer
 400          * to set the Force Card Detect bit. People often don't connect the
 401          * card detect signal and use this pin for another purpose. If the card
 402          * detect pin is not muxed to SDHCI controller, a default value is
 403          * used. This value can be different from a SoC revision to another
 404          * one. Problems come when this default value is not card present. To
 405          * avoid this case, if the device is non removable then the card
 406          * detection procedure using the SDMCC_CD signal is bypassed.
 407          * This bit is reset when a software reset for all command is performed
 408          * so we need to implement our own reset function to set back this bit.
 409          *
 410          * WA: SAMA5D2 doesn't drive CMD if using CD GPIO line.
 411          */
 412         if ((host->mmc->caps & MMC_CAP_NONREMOVABLE)
 413             || mmc_gpio_get_cd(host->mmc) >= 0)
 414                 sdhci_at91_set_force_card_detect(host);
 415
 416         pm_runtime_put_autosuspend(&pdev->dev);
 417
 418         return 0;
 419
 420 pm_runtime_disable:
 421         pm_runtime_disable(&pdev->dev);
 422         pm_runtime_set_suspended(&pdev->dev);
 423         pm_runtime_put_noidle(&pdev->dev);
 424 clocks_disable_unprepare:
 425         clk_disable_unprepare(priv->gck);
 426         clk_disable_unprepare(priv->mainck);
 427         clk_disable_unprepare(priv->hclock);
 428 sdhci_pltfm_free:
 429         sdhci_pltfm_free(pdev);
 430         return ret;
 431 }
 432
 433 static int sdhci_at91_remove(struct platform_device *pdev)
 434 {
 435         struct sdhci_host       *host = platform_get_drvdata(pdev);
 436         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
 437         struct sdhci_at91_priv  *priv = sdhci_pltfm_priv(pltfm_host);
 438         struct clk *gck = priv->gck;
 439         struct clk *hclock = priv->hclock;
 440         struct clk *mainck = priv->mainck;
 441
 442         pm_runtime_get_sync(&pdev->dev);
 443         pm_runtime_disable(&pdev->dev);
 444         pm_runtime_put_noidle(&pdev->dev);
 445
 446         sdhci_pltfm_unregister(pdev);
 447
 448         clk_disable_unprepare(gck);
 449         clk_disable_unprepare(hclock);
 450         clk_disable_unprepare(mainck);
 451
 452         return 0;
 453 }
 454
 455 static struct platform_driver sdhci_at91_driver = {
 456         .driver         = {
 457                 .name   = "sdhci-at91",
 458                 .of_match_table = sdhci_at91_dt_match,
 459                 .pm     = &sdhci_at91_dev_pm_ops,
 460         },
 461         .probe          = sdhci_at91_probe,
 462         .remove         = sdhci_at91_remove,
 463 };
 464
 465 module_platform_driver(sdhci_at91_driver);
 466
 467 MODULE_DESCRIPTION("SDHCI driver for at91");
 468 MODULE_AUTHOR("Ludovic Desroches <ludovic.desroches@atmel.com>");
 469 MODULE_LICENSE("GPL v2");