drivers/mmc/host/sdhci-s3c.c

   1 /* linux/drivers/mmc/host/sdhci-s3c.c
   2  *
   3  * Copyright 2008 Openmoko Inc.
   4  * Copyright 2008 Simtec Electronics
   5  *      Ben Dooks <ben@simtec.co.uk>
   6  *      http://armlinux.simtec.co.uk/
   7  *
   8  * SDHCI (HSMMC) support for Samsung SoC
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  */
  14
  15 #include <linux/delay.h>
  16 #include <linux/dma-mapping.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/slab.h>
  19 #include <linux/clk.h>
  20 #include <linux/io.h>
  21 #include <linux/gpio.h>
  22
  23 #include <linux/mmc/host.h>
  24
  25 #include <plat/sdhci.h>
  26 #include <plat/regs-sdhci.h>
  27
  28 #include "sdhci.h"
  29
  30 #define MAX_BUS_CLK     (4)
  31
  32 /**
  33  * struct sdhci_s3c - S3C SDHCI instance
  34  * @host: The SDHCI host created
  35  * @pdev: The platform device we where created from.
  36  * @ioarea: The resource created when we claimed the IO area.
  37  * @pdata: The platform data for this controller.
  38  * @cur_clk: The index of the current bus clock.
  39  * @clk_io: The clock for the internal bus interface.
  40  * @clk_bus: The clocks that are available for the SD/MMC bus clock.
  41  */
  42 struct sdhci_s3c {
  43         struct sdhci_host       *host;
  44         struct platform_device  *pdev;
  45         struct resource         *ioarea;
  46         struct s3c_sdhci_platdata *pdata;
  47         unsigned int            cur_clk;
  48         int                     ext_cd_irq;
  49         int                     ext_cd_gpio;
  50
  51         struct clk              *clk_io;
  52         struct clk              *clk_bus[MAX_BUS_CLK];
  53 };
  54
  55 static inline struct sdhci_s3c *to_s3c(struct sdhci_host *host)
  56 {
  57         return sdhci_priv(host);
  58 }
  59
  60 /**
  61  * get_curclk - convert ctrl2 register to clock source number
  62  * @ctrl2: Control2 register value.
  63  */
  64 static u32 get_curclk(u32 ctrl2)
  65 {
  66         ctrl2 &= S3C_SDHCI_CTRL2_SELBASECLK_MASK;
  67         ctrl2 >>= S3C_SDHCI_CTRL2_SELBASECLK_SHIFT;
  68
  69         return ctrl2;
  70 }
  71
  72 static void sdhci_s3c_check_sclk(struct sdhci_host *host)
  73 {
  74         struct sdhci_s3c *ourhost = to_s3c(host);
  75         u32 tmp = readl(host->ioaddr + S3C_SDHCI_CONTROL2);
  76
  77         if (get_curclk(tmp) != ourhost->cur_clk) {
  78                 dev_dbg(&ourhost->pdev->dev, "restored ctrl2 clock setting\n");
  79
  80                 tmp &= ~S3C_SDHCI_CTRL2_SELBASECLK_MASK;
  81                 tmp |= ourhost->cur_clk << S3C_SDHCI_CTRL2_SELBASECLK_SHIFT;
  82                 writel(tmp, host->ioaddr + 0x80);
  83         }
  84 }
  85
  86 /**
  87  * sdhci_s3c_get_max_clk - callback to get maximum clock frequency.
  88  * @host: The SDHCI host instance.
  89  *
  90  * Callback to return the maximum clock rate acheivable by the controller.
  91 */
  92 static unsigned int sdhci_s3c_get_max_clk(struct sdhci_host *host)
  93 {
  94         struct sdhci_s3c *ourhost = to_s3c(host);
  95         struct clk *busclk;
  96         unsigned int rate, max;
  97         int clk;
  98
  99         /* note, a reset will reset the clock source */
 100
 101         sdhci_s3c_check_sclk(host);
 102
 103         for (max = 0, clk = 0; clk < MAX_BUS_CLK; clk++) {
 104                 busclk = ourhost->clk_bus[clk];
 105                 if (!busclk)
 106                         continue;
 107
 108                 rate = clk_get_rate(busclk);
 109                 if (rate > max)
 110                         max = rate;
 111         }
 112
 113         return max;
 114 }
 115
 116 /**
 117  * sdhci_s3c_consider_clock - consider one the bus clocks for current setting
 118  * @ourhost: Our SDHCI instance.
 119  * @src: The source clock index.
 120  * @wanted: The clock frequency wanted.
 121  */
 122 static unsigned int sdhci_s3c_consider_clock(struct sdhci_s3c *ourhost,
 123                                              unsigned int src,
 124                                              unsigned int wanted)
 125 {
 126         unsigned long rate;
 127         struct clk *clksrc = ourhost->clk_bus[src];
 128         int div;
 129
 130         if (!clksrc)
 131                 return UINT_MAX;
 132
 133         /*
 134          * Clock divider's step is different as 1 from that of host controller
 135          * when 'clk_type' is S3C_SDHCI_CLK_DIV_EXTERNAL.
 136          */
 137         if (ourhost->pdata->clk_type) {
 138                 rate = clk_round_rate(clksrc, wanted);
 139                 return wanted - rate;
 140         }
 141
 142         rate = clk_get_rate(clksrc);
 143
 144         for (div = 1; div < 256; div *= 2) {
 145                 if ((rate / div) <= wanted)
 146                         break;
 147         }
 148
 149         dev_dbg(&ourhost->pdev->dev, "clk %d: rate %ld, want %d, got %ld\n",
 150                 src, rate, wanted, rate / div);
 151
 152         return (wanted - (rate / div));
 153 }
 154
 155 /**
 156  * sdhci_s3c_set_clock - callback on clock change
 157  * @host: The SDHCI host being changed
 158  * @clock: The clock rate being requested.
 159  *
 160  * When the card's clock is going to be changed, look at the new frequency
 161  * and find the best clock source to go with it.
 162 */
 163 static void sdhci_s3c_set_clock(struct sdhci_host *host, unsigned int clock)
 164 {
 165         struct sdhci_s3c *ourhost = to_s3c(host);
 166         unsigned int best = UINT_MAX;
 167         unsigned int delta;
 168         int best_src = 0;
 169         int src;
 170         u32 ctrl;
 171
 172         /* don't bother if the clock is going off. */
 173         if (clock == 0)
 174                 return;
 175
 176         for (src = 0; src < MAX_BUS_CLK; src++) {
 177                 delta = sdhci_s3c_consider_clock(ourhost, src, clock);
 178                 if (delta < best) {
 179                         best = delta;
 180                         best_src = src;
 181                 }
 182         }
 183
 184         dev_dbg(&ourhost->pdev->dev,
 185                 "selected source %d, clock %d, delta %d\n",
 186                  best_src, clock, best);
 187
 188         /* select the new clock source */
 189
 190         if (ourhost->cur_clk != best_src) {
 191                 struct clk *clk = ourhost->clk_bus[best_src];
 192
 193                 /* turn clock off to card before changing clock source */
 194                 writew(0, host->ioaddr + SDHCI_CLOCK_CONTROL);
 195
 196                 ourhost->cur_clk = best_src;
 197                 host->max_clk = clk_get_rate(clk);
 198
 199                 ctrl = readl(host->ioaddr + S3C_SDHCI_CONTROL2);
 200                 ctrl &= ~S3C_SDHCI_CTRL2_SELBASECLK_MASK;
 201                 ctrl |= best_src << S3C_SDHCI_CTRL2_SELBASECLK_SHIFT;
 202                 writel(ctrl, host->ioaddr + S3C_SDHCI_CONTROL2);
 203         }
 204
 205         /* reconfigure the hardware for new clock rate */
 206
 207         {
 208                 struct mmc_ios ios;
 209
 210                 ios.clock = clock;
 211
 212                 if (ourhost->pdata->cfg_card)
 213                         (ourhost->pdata->cfg_card)(ourhost->pdev, host->ioaddr,
 214                                                    &ios, NULL);
 215         }
 216 }
 217
 218 /**
 219  * sdhci_s3c_get_min_clock - callback to get minimal supported clock value
 220  * @host: The SDHCI host being queried
 221  *
 222  * To init mmc host properly a minimal clock value is needed. For high system
 223  * bus clock's values the standard formula gives values out of allowed range.
 224  * The clock still can be set to lower values, if clock source other then
 225  * system bus is selected.
 226 */
 227 static unsigned int sdhci_s3c_get_min_clock(struct sdhci_host *host)
 228 {
 229         struct sdhci_s3c *ourhost = to_s3c(host);
 230         unsigned int delta, min = UINT_MAX;
 231         int src;
 232
 233         for (src = 0; src < MAX_BUS_CLK; src++) {
 234                 delta = sdhci_s3c_consider_clock(ourhost, src, 0);
 235                 if (delta == UINT_MAX)
 236                         continue;
 237                 /* delta is a negative value in this case */
 238                 if (-delta < min)
 239                         min = -delta;
 240         }
 241         return min;
 242 }
 243
 244 /* sdhci_cmu_get_max_clk - callback to get maximum clock frequency.*/
 245 static unsigned int sdhci_cmu_get_max_clock(struct sdhci_host *host)
 246 {
 247         struct sdhci_s3c *ourhost = to_s3c(host);
 248
 249         return clk_round_rate(ourhost->clk_bus[ourhost->cur_clk], UINT_MAX);
 250 }
 251
 252 /* sdhci_cmu_get_min_clock - callback to get minimal supported clock value. */
 253 static unsigned int sdhci_cmu_get_min_clock(struct sdhci_host *host)
 254 {
 255         struct sdhci_s3c *ourhost = to_s3c(host);
 256
 257         /*
 258          * initial clock can be in the frequency range of
 259          * 100KHz-400KHz, so we set it as max value.
 260          */
 261         return clk_round_rate(ourhost->clk_bus[ourhost->cur_clk], 400000);
 262 }
 263
 264 /* sdhci_cmu_set_clock - callback on clock change.*/
 265 static void sdhci_cmu_set_clock(struct sdhci_host *host, unsigned int clock)
 266 {
 267         struct sdhci_s3c *ourhost = to_s3c(host);
 268
 269         /* don't bother if the clock is going off */
 270         if (clock == 0)
 271                 return;
 272
 273         sdhci_s3c_set_clock(host, clock);
 274
 275         clk_set_rate(ourhost->clk_bus[ourhost->cur_clk], clock);
 276
 277         host->clock = clock;
 278 }
 279
 280 static struct sdhci_ops sdhci_s3c_ops = {
 281         .get_max_clock          = sdhci_s3c_get_max_clk,
 282         .set_clock              = sdhci_s3c_set_clock,
 283         .get_min_clock          = sdhci_s3c_get_min_clock,
 284 };
 285
 286 static void sdhci_s3c_notify_change(struct platform_device *dev, int state)
 287 {
 288         struct sdhci_host *host = platform_get_drvdata(dev);
 289         unsigned long flags;
 290
 291         if (host) {
 292                 spin_lock_irqsave(&host->lock, flags);
 293                 if (state) {
 294                         dev_dbg(&dev->dev, "card inserted.\n");
 295                         host->flags &= ~SDHCI_DEVICE_DEAD;
 296                         host->quirks |= SDHCI_QUIRK_BROKEN_CARD_DETECTION;
 297                 } else {
 298                         dev_dbg(&dev->dev, "card removed.\n");
 299                         host->flags |= SDHCI_DEVICE_DEAD;
 300                         host->quirks &= ~SDHCI_QUIRK_BROKEN_CARD_DETECTION;
 301                 }
 302                 tasklet_schedule(&host->card_tasklet);
 303                 spin_unlock_irqrestore(&host->lock, flags);
 304         }
 305 }
 306
 307 static irqreturn_t sdhci_s3c_gpio_card_detect_thread(int irq, void *dev_id)
 308 {
 309         struct sdhci_s3c *sc = dev_id;
 310         int status = gpio_get_value(sc->ext_cd_gpio);
 311         if (sc->pdata->ext_cd_gpio_invert)
 312                 status = !status;
 313         sdhci_s3c_notify_change(sc->pdev, status);
 314         return IRQ_HANDLED;
 315 }
 316
 317 static void sdhci_s3c_setup_card_detect_gpio(struct sdhci_s3c *sc)
 318 {
 319         struct s3c_sdhci_platdata *pdata = sc->pdata;
 320         struct device *dev = &sc->pdev->dev;
 321
 322         if (gpio_request(pdata->ext_cd_gpio, "SDHCI EXT CD") == 0) {
 323                 sc->ext_cd_gpio = pdata->ext_cd_gpio;
 324                 sc->ext_cd_irq = gpio_to_irq(pdata->ext_cd_gpio);
 325                 if (sc->ext_cd_irq &&
 326                     request_threaded_irq(sc->ext_cd_irq, NULL,
 327                                          sdhci_s3c_gpio_card_detect_thread,
 328                                          IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
 329                                          dev_name(dev), sc) == 0) {
 330                         int status = gpio_get_value(sc->ext_cd_gpio);
 331                         if (pdata->ext_cd_gpio_invert)
 332                                 status = !status;
 333                         sdhci_s3c_notify_change(sc->pdev, status);
 334                 } else {
 335                         dev_warn(dev, "cannot request irq for card detect\n");
 336                         sc->ext_cd_irq = 0;
 337                 }
 338         } else {
 339                 dev_err(dev, "cannot request gpio for card detect\n");
 340         }
 341 }
 342
 343 static int __devinit sdhci_s3c_probe(struct platform_device *pdev)
 344 {
 345         struct s3c_sdhci_platdata *pdata = pdev->dev.platform_data;
 346         struct device *dev = &pdev->dev;
 347         struct sdhci_host *host;
 348         struct sdhci_s3c *sc;
 349         struct resource *res;
 350         int ret, irq, ptr, clks;
 351
 352         if (!pdata) {
 353                 dev_err(dev, "no device data specified\n");
 354                 return -ENOENT;
 355         }
 356
 357         irq = platform_get_irq(pdev, 0);
 358         if (irq < 0) {
 359                 dev_err(dev, "no irq specified\n");
 360                 return irq;
 361         }
 362
 363         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 364         if (!res) {
 365                 dev_err(dev, "no memory specified\n");
 366                 return -ENOENT;
 367         }
 368
 369         host = sdhci_alloc_host(dev, sizeof(struct sdhci_s3c));
 370         if (IS_ERR(host)) {
 371                 dev_err(dev, "sdhci_alloc_host() failed\n");
 372                 return PTR_ERR(host);
 373         }
 374
 375         sc = sdhci_priv(host);
 376
 377         sc->host = host;
 378         sc->pdev = pdev;
 379         sc->pdata = pdata;
 380         sc->ext_cd_gpio = -1; /* invalid gpio number */
 381
 382         platform_set_drvdata(pdev, host);
 383
 384         sc->clk_io = clk_get(dev, "hsmmc");
 385         if (IS_ERR(sc->clk_io)) {
 386                 dev_err(dev, "failed to get io clock\n");
 387                 ret = PTR_ERR(sc->clk_io);
 388                 goto err_io_clk;
 389         }
 390
 391         /* enable the local io clock and keep it running for the moment. */
 392         clk_enable(sc->clk_io);
 393
 394         for (clks = 0, ptr = 0; ptr < MAX_BUS_CLK; ptr++) {
 395                 struct clk *clk;
 396                 char *name = pdata->clocks[ptr];
 397
 398                 if (name == NULL)
 399                         continue;
 400
 401                 clk = clk_get(dev, name);
 402                 if (IS_ERR(clk)) {
 403                         dev_err(dev, "failed to get clock %s\n", name);
 404                         continue;
 405                 }
 406
 407                 clks++;
 408                 sc->clk_bus[ptr] = clk;
 409
 410                 /*
 411                  * save current clock index to know which clock bus
 412                  * is used later in overriding functions.
 413                  */
 414                 sc->cur_clk = ptr;
 415
 416                 clk_enable(clk);
 417
 418                 dev_info(dev, "clock source %d: %s (%ld Hz)\n",
 419                          ptr, name, clk_get_rate(clk));
 420         }
 421
 422         if (clks == 0) {
 423                 dev_err(dev, "failed to find any bus clocks\n");
 424                 ret = -ENOENT;
 425                 goto err_no_busclks;
 426         }
 427
 428         sc->ioarea = request_mem_region(res->start, resource_size(res),
 429                                         mmc_hostname(host->mmc));
 430         if (!sc->ioarea) {
 431                 dev_err(dev, "failed to reserve register area\n");
 432                 ret = -ENXIO;
 433                 goto err_req_regs;
 434         }
 435
 436         host->ioaddr = ioremap_nocache(res->start, resource_size(res));
 437         if (!host->ioaddr) {
 438                 dev_err(dev, "failed to map registers\n");
 439                 ret = -ENXIO;
 440                 goto err_req_regs;
 441         }
 442
 443         /* Ensure we have minimal gpio selected CMD/CLK/Detect */
 444         if (pdata->cfg_gpio)
 445                 pdata->cfg_gpio(pdev, pdata->max_width);
 446
 447         host->hw_name = "samsung-hsmmc";
 448         host->ops = &sdhci_s3c_ops;
 449         host->quirks = 0;
 450         host->irq = irq;
 451
 452         /* Setup quirks for the controller */
 453         host->quirks |= SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC;
 454         host->quirks |= SDHCI_QUIRK_NO_HISPD_BIT;
 455
 456 #ifndef CONFIG_MMC_SDHCI_S3C_DMA
 457
 458         /* we currently see overruns on errors, so disable the SDMA
 459          * support as well. */
 460         host->quirks |= SDHCI_QUIRK_BROKEN_DMA;
 461
 462 #endif /* CONFIG_MMC_SDHCI_S3C_DMA */
 463
 464         /* It seems we do not get an DATA transfer complete on non-busy
 465          * transfers, not sure if this is a problem with this specific
 466          * SDHCI block, or a missing configuration that needs to be set. */
 467         host->quirks |= SDHCI_QUIRK_NO_BUSY_IRQ;
 468
 469         if (pdata->cd_type == S3C_SDHCI_CD_NONE ||
 470             pdata->cd_type == S3C_SDHCI_CD_PERMANENT)
 471                 host->quirks |= SDHCI_QUIRK_BROKEN_CARD_DETECTION;
 472
 473         if (pdata->cd_type == S3C_SDHCI_CD_PERMANENT)
 474                 host->mmc->caps = MMC_CAP_NONREMOVABLE;
 475
 476         host->quirks |= (SDHCI_QUIRK_32BIT_DMA_ADDR |
 477                          SDHCI_QUIRK_32BIT_DMA_SIZE);
 478
 479         /* HSMMC on Samsung SoCs uses SDCLK as timeout clock */
 480         host->quirks |= SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK;
 481
 482         /*
 483          * If controller does not have internal clock divider,
 484          * we can use overriding functions instead of default.
 485          */
 486         if (pdata->clk_type) {
 487                 sdhci_s3c_ops.set_clock = sdhci_cmu_set_clock;
 488                 sdhci_s3c_ops.get_min_clock = sdhci_cmu_get_min_clock;
 489                 sdhci_s3c_ops.get_max_clock = sdhci_cmu_get_max_clock;
 490         }
 491
 492         /* It supports additional host capabilities if needed */
 493         if (pdata->host_caps)
 494                 host->mmc->caps |= pdata->host_caps;
 495
 496         ret = sdhci_add_host(host);
 497         if (ret) {
 498                 dev_err(dev, "sdhci_add_host() failed\n");
 499                 goto err_add_host;
 500         }
 501
 502         /* The following two methods of card detection might call
 503            sdhci_s3c_notify_change() immediately, so they can be called
 504            only after sdhci_add_host(). Setup errors are ignored. */
 505         if (pdata->cd_type == S3C_SDHCI_CD_EXTERNAL && pdata->ext_cd_init)
 506                 pdata->ext_cd_init(&sdhci_s3c_notify_change);
 507         if (pdata->cd_type == S3C_SDHCI_CD_GPIO &&
 508             gpio_is_valid(pdata->ext_cd_gpio))
 509                 sdhci_s3c_setup_card_detect_gpio(sc);
 510
 511         return 0;
 512
 513  err_add_host:
 514         release_resource(sc->ioarea);
 515         kfree(sc->ioarea);
 516
 517  err_req_regs:
 518         for (ptr = 0; ptr < MAX_BUS_CLK; ptr++) {
 519                 clk_disable(sc->clk_bus[ptr]);
 520                 clk_put(sc->clk_bus[ptr]);
 521         }
 522
 523  err_no_busclks:
 524         clk_disable(sc->clk_io);
 525         clk_put(sc->clk_io);
 526
 527  err_io_clk:
 528         sdhci_free_host(host);
 529
 530         return ret;
 531 }
 532
 533 static int __devexit sdhci_s3c_remove(struct platform_device *pdev)
 534 {
 535         struct s3c_sdhci_platdata *pdata = pdev->dev.platform_data;
 536         struct sdhci_host *host =  platform_get_drvdata(pdev);
 537         struct sdhci_s3c *sc = sdhci_priv(host);
 538         int ptr;
 539
 540         if (pdata->cd_type == S3C_SDHCI_CD_EXTERNAL && pdata->ext_cd_cleanup)
 541                 pdata->ext_cd_cleanup(&sdhci_s3c_notify_change);
 542
 543         if (sc->ext_cd_irq)
 544                 free_irq(sc->ext_cd_irq, sc);
 545
 546         if (gpio_is_valid(sc->ext_cd_gpio))
 547                 gpio_free(sc->ext_cd_gpio);
 548
 549         sdhci_remove_host(host, 1);
 550
 551         for (ptr = 0; ptr < 3; ptr++) {
 552                 if (sc->clk_bus[ptr]) {
 553                         clk_disable(sc->clk_bus[ptr]);
 554                         clk_put(sc->clk_bus[ptr]);
 555                 }
 556         }
 557         clk_disable(sc->clk_io);
 558         clk_put(sc->clk_io);
 559
 560         iounmap(host->ioaddr);
 561         release_resource(sc->ioarea);
 562         kfree(sc->ioarea);
 563
 564         sdhci_free_host(host);
 565         platform_set_drvdata(pdev, NULL);
 566
 567         return 0;
 568 }
 569
 570 #ifdef CONFIG_PM
 571
 572 static int sdhci_s3c_suspend(struct platform_device *dev, pm_message_t pm)
 573 {
 574         struct sdhci_host *host = platform_get_drvdata(dev);
 575
 576         sdhci_suspend_host(host, pm);
 577         return 0;
 578 }
 579
 580 static int sdhci_s3c_resume(struct platform_device *dev)
 581 {
 582         struct sdhci_host *host = platform_get_drvdata(dev);
 583
 584         sdhci_resume_host(host);
 585         return 0;
 586 }
 587
 588 #else
 589 #define sdhci_s3c_suspend NULL
 590 #define sdhci_s3c_resume NULL
 591 #endif
 592
 593 static struct platform_driver sdhci_s3c_driver = {
 594         .probe          = sdhci_s3c_probe,
 595         .remove         = __devexit_p(sdhci_s3c_remove),
 596         .suspend        = sdhci_s3c_suspend,
 597         .resume         = sdhci_s3c_resume,
 598         .driver         = {
 599                 .owner  = THIS_MODULE,
 600                 .name   = "s3c-sdhci",
 601         },
 602 };
 603
 604 static int __init sdhci_s3c_init(void)
 605 {
 606         return platform_driver_register(&sdhci_s3c_driver);
 607 }
 608
 609 static void __exit sdhci_s3c_exit(void)
 610 {
 611         platform_driver_unregister(&sdhci_s3c_driver);
 612 }
 613
 614 module_init(sdhci_s3c_init);
 615 module_exit(sdhci_s3c_exit);
 616
 617 MODULE_DESCRIPTION("Samsung SDHCI (HSMMC) glue");
 618 MODULE_AUTHOR("Ben Dooks, <ben@simtec.co.uk>");
 619 MODULE_LICENSE("GPL v2");
 620 MODULE_ALIAS("platform:s3c-sdhci");