drivers/mmc/host/sh_mobile_sdhi.c

   1 /*
   2  * SuperH Mobile SDHI
   3  *
   4  * Copyright (C) 2016 Sang Engineering, Wolfram Sang
   5  * Copyright (C) 2015-16 Renesas Electronics Corporation
   6  * Copyright (C) 2009 Magnus Damm
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  * Based on "Compaq ASIC3 support":
  13  *
  14  * Copyright 2001 Compaq Computer Corporation.
  15  * Copyright 2004-2005 Phil Blundell
  16  * Copyright 2007-2008 OpenedHand Ltd.
  17  *
  18  * Authors: Phil Blundell <pb@handhelds.org>,
  19  *          Samuel Ortiz <sameo@openedhand.com>
  20  *
  21  */
  22
  23 #include <linux/kernel.h>
  24 #include <linux/clk.h>
  25 #include <linux/slab.h>
  26 #include <linux/mod_devicetable.h>
  27 #include <linux/module.h>
  28 #include <linux/of_device.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/mmc/host.h>
  31 #include <linux/mmc/sh_mobile_sdhi.h>
  32 #include <linux/mfd/tmio.h>
  33 #include <linux/sh_dma.h>
  34 #include <linux/delay.h>
  35
  36 #include "tmio_mmc.h"
  37
  38 #define EXT_ACC           0xe4
  39
  40 #define host_to_priv(host) container_of((host)->pdata, struct sh_mobile_sdhi, mmc_data)
  41
  42 struct sh_mobile_sdhi_of_data {
  43         unsigned long tmio_flags;
  44         unsigned long capabilities;
  45         unsigned long capabilities2;
  46         enum dma_slave_buswidth dma_buswidth;
  47         dma_addr_t dma_rx_offset;
  48         unsigned bus_shift;
  49 };
  50
  51 static const struct sh_mobile_sdhi_of_data sh_mobile_sdhi_of_cfg[] = {
  52         {
  53                 .tmio_flags = TMIO_MMC_HAS_IDLE_WAIT,
  54         },
  55 };
  56
  57 static const struct sh_mobile_sdhi_of_data of_rcar_gen1_compatible = {
  58         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE |
  59                           TMIO_MMC_CLK_ACTUAL,
  60         .capabilities   = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
  61 };
  62
  63 static const struct sh_mobile_sdhi_of_data of_rcar_gen2_compatible = {
  64         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE |
  65                           TMIO_MMC_CLK_ACTUAL | TMIO_MMC_FAST_CLK_CHG,
  66         .capabilities   = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
  67         .dma_buswidth   = DMA_SLAVE_BUSWIDTH_4_BYTES,
  68         .dma_rx_offset  = 0x2000,
  69 };
  70
  71 static const struct sh_mobile_sdhi_of_data of_rcar_gen3_compatible = {
  72         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE |
  73                           TMIO_MMC_CLK_ACTUAL | TMIO_MMC_FAST_CLK_CHG,
  74         .capabilities   = MMC_CAP_SD_HIGHSPEED,
  75         .bus_shift      = 2,
  76 };
  77
  78 static const struct of_device_id sh_mobile_sdhi_of_match[] = {
  79         { .compatible = "renesas,sdhi-shmobile" },
  80         { .compatible = "renesas,sdhi-sh7372" },
  81         { .compatible = "renesas,sdhi-sh73a0", .data = &sh_mobile_sdhi_of_cfg[0], },
  82         { .compatible = "renesas,sdhi-r8a73a4", .data = &sh_mobile_sdhi_of_cfg[0], },
  83         { .compatible = "renesas,sdhi-r8a7740", .data = &sh_mobile_sdhi_of_cfg[0], },
  84         { .compatible = "renesas,sdhi-r8a7778", .data = &of_rcar_gen1_compatible, },
  85         { .compatible = "renesas,sdhi-r8a7779", .data = &of_rcar_gen1_compatible, },
  86         { .compatible = "renesas,sdhi-r8a7790", .data = &of_rcar_gen2_compatible, },
  87         { .compatible = "renesas,sdhi-r8a7791", .data = &of_rcar_gen2_compatible, },
  88         { .compatible = "renesas,sdhi-r8a7792", .data = &of_rcar_gen2_compatible, },
  89         { .compatible = "renesas,sdhi-r8a7793", .data = &of_rcar_gen2_compatible, },
  90         { .compatible = "renesas,sdhi-r8a7794", .data = &of_rcar_gen2_compatible, },
  91         { .compatible = "renesas,sdhi-r8a7795", .data = &of_rcar_gen3_compatible, },
  92         {},
  93 };
  94 MODULE_DEVICE_TABLE(of, sh_mobile_sdhi_of_match);
  95
  96 struct sh_mobile_sdhi {
  97         struct clk *clk;
  98         struct tmio_mmc_data mmc_data;
  99         struct tmio_mmc_dma dma_priv;
 100 };
 101
 102 static void sh_mobile_sdhi_sdbuf_width(struct tmio_mmc_host *host, int width)
 103 {
 104         u32 val;
 105
 106         /*
 107          * see also
 108          *      sh_mobile_sdhi_of_data :: dma_buswidth
 109          */
 110         switch (sd_ctrl_read16(host, CTL_VERSION)) {
 111         case 0x490C:
 112                 val = (width == 32) ? 0x0001 : 0x0000;
 113                 break;
 114         case 0xCB0D:
 115                 val = (width == 32) ? 0x0000 : 0x0001;
 116                 break;
 117         case 0xCC10: /* Gen3, SD only */
 118         case 0xCD10: /* Gen3, SD + MMC */
 119                 if (width == 64)
 120                         val = 0x0000;
 121                 else if (width == 32)
 122                         val = 0x0101;
 123                 else
 124                         val = 0x0001;
 125                 break;
 126         default:
 127                 /* nothing to do */
 128                 return;
 129         }
 130
 131         sd_ctrl_write16(host, EXT_ACC, val);
 132 }
 133
 134 static int sh_mobile_sdhi_clk_enable(struct tmio_mmc_host *host)
 135 {
 136         struct mmc_host *mmc = host->mmc;
 137         struct sh_mobile_sdhi *priv = host_to_priv(host);
 138         int ret = clk_prepare_enable(priv->clk);
 139         if (ret < 0)
 140                 return ret;
 141
 142         /*
 143          * The clock driver may not know what maximum frequency
 144          * actually works, so it should be set with the max-frequency
 145          * property which will already have been read to f_max.  If it
 146          * was missing, assume the current frequency is the maximum.
 147          */
 148         if (!mmc->f_max)
 149                 mmc->f_max = clk_get_rate(priv->clk);
 150
 151         /*
 152          * Minimum frequency is the minimum input clock frequency
 153          * divided by our maximum divider.
 154          */
 155         mmc->f_min = max(clk_round_rate(priv->clk, 1) / 512, 1L);
 156
 157         /* enable 16bit data access on SDBUF as default */
 158         sh_mobile_sdhi_sdbuf_width(host, 16);
 159
 160         return 0;
 161 }
 162
 163 static unsigned int sh_mobile_sdhi_clk_update(struct tmio_mmc_host *host,
 164                                               unsigned int new_clock)
 165 {
 166         struct sh_mobile_sdhi *priv = host_to_priv(host);
 167         unsigned int freq, best_freq, diff_min, diff;
 168         int i;
 169
 170         diff_min = ~0;
 171         best_freq = 0;
 172
 173         /*
 174          * We want the bus clock to be as close as possible to, but no
 175          * greater than, new_clock.  As we can divide by 1 << i for
 176          * any i in [0, 9] we want the input clock to be as close as
 177          * possible, but no greater than, new_clock << i.
 178          */
 179         for (i = min(9, ilog2(UINT_MAX / new_clock)); i >= 0; i--) {
 180                 freq = clk_round_rate(priv->clk, new_clock << i);
 181                 if (freq > (new_clock << i)) {
 182                         /* Too fast; look for a slightly slower option */
 183                         freq = clk_round_rate(priv->clk,
 184                                               (new_clock << i) / 4 * 3);
 185                         if (freq > (new_clock << i))
 186                                 continue;
 187                 }
 188
 189                 diff = new_clock - (freq >> i);
 190                 if (diff <= diff_min) {
 191                         best_freq = freq;
 192                         diff_min = diff;
 193                 }
 194         }
 195
 196         clk_set_rate(priv->clk, best_freq);
 197
 198         return best_freq;
 199 }
 200
 201 static void sh_mobile_sdhi_clk_disable(struct tmio_mmc_host *host)
 202 {
 203         struct sh_mobile_sdhi *priv = host_to_priv(host);
 204
 205         clk_disable_unprepare(priv->clk);
 206 }
 207
 208 static int sh_mobile_sdhi_wait_idle(struct tmio_mmc_host *host)
 209 {
 210         int timeout = 1000;
 211
 212         while (--timeout && !(sd_ctrl_read16(host, CTL_STATUS2) & (1 << 13)))
 213                 udelay(1);
 214
 215         if (!timeout) {
 216                 dev_warn(&host->pdev->dev, "timeout waiting for SD bus idle\n");
 217                 return -EBUSY;
 218         }
 219
 220         return 0;
 221 }
 222
 223 static int sh_mobile_sdhi_write16_hook(struct tmio_mmc_host *host, int addr)
 224 {
 225         switch (addr)
 226         {
 227         case CTL_SD_CMD:
 228         case CTL_STOP_INTERNAL_ACTION:
 229         case CTL_XFER_BLK_COUNT:
 230         case CTL_SD_CARD_CLK_CTL:
 231         case CTL_SD_XFER_LEN:
 232         case CTL_SD_MEM_CARD_OPT:
 233         case CTL_TRANSACTION_CTL:
 234         case CTL_DMA_ENABLE:
 235         case EXT_ACC:
 236                 return sh_mobile_sdhi_wait_idle(host);
 237         }
 238
 239         return 0;
 240 }
 241
 242 static int sh_mobile_sdhi_multi_io_quirk(struct mmc_card *card,
 243                                          unsigned int direction, int blk_size)
 244 {
 245         /*
 246          * In Renesas controllers, when performing a
 247          * multiple block read of one or two blocks,
 248          * depending on the timing with which the
 249          * response register is read, the response
 250          * value may not be read properly.
 251          * Use single block read for this HW bug
 252          */
 253         if ((direction == MMC_DATA_READ) &&
 254             blk_size == 2)
 255                 return 1;
 256
 257         return blk_size;
 258 }
 259
 260 static void sh_mobile_sdhi_enable_dma(struct tmio_mmc_host *host, bool enable)
 261 {
 262         sd_ctrl_write16(host, CTL_DMA_ENABLE, enable ? 2 : 0);
 263
 264         /* enable 32bit access if DMA mode if possibile */
 265         sh_mobile_sdhi_sdbuf_width(host, enable ? 32 : 16);
 266 }
 267
 268 static int sh_mobile_sdhi_probe(struct platform_device *pdev)
 269 {
 270         const struct of_device_id *of_id =
 271                 of_match_device(sh_mobile_sdhi_of_match, &pdev->dev);
 272         struct sh_mobile_sdhi *priv;
 273         struct tmio_mmc_data *mmc_data;
 274         struct tmio_mmc_data *mmd = pdev->dev.platform_data;
 275         struct tmio_mmc_host *host;
 276         struct resource *res;
 277         int irq, ret, i = 0;
 278         bool multiplexed_isr = true;
 279         struct tmio_mmc_dma *dma_priv;
 280
 281         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 282         if (!res)
 283                 return -EINVAL;
 284
 285         priv = devm_kzalloc(&pdev->dev, sizeof(struct sh_mobile_sdhi), GFP_KERNEL);
 286         if (!priv)
 287                 return -ENOMEM;
 288
 289         mmc_data = &priv->mmc_data;
 290         dma_priv = &priv->dma_priv;
 291
 292         priv->clk = devm_clk_get(&pdev->dev, NULL);
 293         if (IS_ERR(priv->clk)) {
 294                 ret = PTR_ERR(priv->clk);
 295                 dev_err(&pdev->dev, "cannot get clock: %d\n", ret);
 296                 goto eprobe;
 297         }
 298
 299         host = tmio_mmc_host_alloc(pdev);
 300         if (!host) {
 301                 ret = -ENOMEM;
 302                 goto eprobe;
 303         }
 304
 305         if (of_id && of_id->data) {
 306                 const struct sh_mobile_sdhi_of_data *of_data = of_id->data;
 307
 308                 mmc_data->flags |= of_data->tmio_flags;
 309                 mmc_data->capabilities |= of_data->capabilities;
 310                 mmc_data->capabilities2 |= of_data->capabilities2;
 311                 mmc_data->dma_rx_offset = of_data->dma_rx_offset;
 312                 dma_priv->dma_buswidth = of_data->dma_buswidth;
 313                 host->bus_shift = of_data->bus_shift;
 314         }
 315
 316         host->dma               = dma_priv;
 317         host->write16_hook      = sh_mobile_sdhi_write16_hook;
 318         host->clk_enable        = sh_mobile_sdhi_clk_enable;
 319         host->clk_update        = sh_mobile_sdhi_clk_update;
 320         host->clk_disable       = sh_mobile_sdhi_clk_disable;
 321         host->multi_io_quirk    = sh_mobile_sdhi_multi_io_quirk;
 322
 323         /* Orginally registers were 16 bit apart, could be 32 or 64 nowadays */
 324         if (!host->bus_shift && resource_size(res) > 0x100) /* old way to determine the shift */
 325                 host->bus_shift = 1;
 326
 327         if (mmd)
 328                 *mmc_data = *mmd;
 329
 330         dma_priv->filter = shdma_chan_filter;
 331         dma_priv->enable = sh_mobile_sdhi_enable_dma;
 332
 333         mmc_data->alignment_shift = 1; /* 2-byte alignment */
 334         mmc_data->capabilities |= MMC_CAP_MMC_HIGHSPEED;
 335
 336         /*
 337          * All SDHI blocks support 2-byte and larger block sizes in 4-bit
 338          * bus width mode.
 339          */
 340         mmc_data->flags |= TMIO_MMC_BLKSZ_2BYTES;
 341
 342         /*
 343          * All SDHI blocks support SDIO IRQ signalling.
 344          */
 345         mmc_data->flags |= TMIO_MMC_SDIO_IRQ;
 346
 347         /*
 348          * All SDHI have CMD12 controll bit
 349          */
 350         mmc_data->flags |= TMIO_MMC_HAVE_CMD12_CTRL;
 351
 352         /*
 353          * All SDHI need SDIO_INFO1 reserved bit
 354          */
 355         mmc_data->flags |= TMIO_MMC_SDIO_STATUS_QUIRK;
 356
 357         ret = tmio_mmc_host_probe(host, mmc_data);
 358         if (ret < 0)
 359                 goto efree;
 360
 361         /*
 362          * Allow one or more specific (named) ISRs or
 363          * one or more multiplexed (un-named) ISRs.
 364          */
 365
 366         irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_CARD_DETECT);
 367         if (irq >= 0) {
 368                 multiplexed_isr = false;
 369                 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_card_detect_irq, 0,
 370                                   dev_name(&pdev->dev), host);
 371                 if (ret)
 372                         goto eirq;
 373         }
 374
 375         irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_SDIO);
 376         if (irq >= 0) {
 377                 multiplexed_isr = false;
 378                 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_sdio_irq, 0,
 379                                   dev_name(&pdev->dev), host);
 380                 if (ret)
 381                         goto eirq;
 382         }
 383
 384         irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_SDCARD);
 385         if (irq >= 0) {
 386                 multiplexed_isr = false;
 387                 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_sdcard_irq, 0,
 388                                   dev_name(&pdev->dev), host);
 389                 if (ret)
 390                         goto eirq;
 391         } else if (!multiplexed_isr) {
 392                 dev_err(&pdev->dev,
 393                         "Principal SD-card IRQ is missing among named interrupts\n");
 394                 ret = irq;
 395                 goto eirq;
 396         }
 397
 398         if (multiplexed_isr) {
 399                 while (1) {
 400                         irq = platform_get_irq(pdev, i);
 401                         if (irq < 0)
 402                                 break;
 403                         i++;
 404                         ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq, 0,
 405                                           dev_name(&pdev->dev), host);
 406                         if (ret)
 407                                 goto eirq;
 408                 }
 409
 410                 /* There must be at least one IRQ source */
 411                 if (!i) {
 412                         ret = irq;
 413                         goto eirq;
 414                 }
 415         }
 416
 417         dev_info(&pdev->dev, "%s base at 0x%08lx max clock rate %u MHz\n",
 418                  mmc_hostname(host->mmc), (unsigned long)
 419                  (platform_get_resource(pdev, IORESOURCE_MEM, 0)->start),
 420                  host->mmc->f_max / 1000000);
 421
 422         return ret;
 423
 424 eirq:
 425         tmio_mmc_host_remove(host);
 426 efree:
 427         tmio_mmc_host_free(host);
 428 eprobe:
 429         return ret;
 430 }
 431
 432 static int sh_mobile_sdhi_remove(struct platform_device *pdev)
 433 {
 434         struct mmc_host *mmc = platform_get_drvdata(pdev);
 435         struct tmio_mmc_host *host = mmc_priv(mmc);
 436
 437         tmio_mmc_host_remove(host);
 438
 439         return 0;
 440 }
 441
 442 static const struct dev_pm_ops tmio_mmc_dev_pm_ops = {
 443         SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
 444                         pm_runtime_force_resume)
 445         SET_RUNTIME_PM_OPS(tmio_mmc_host_runtime_suspend,
 446                         tmio_mmc_host_runtime_resume,
 447                         NULL)
 448 };
 449
 450 static struct platform_driver sh_mobile_sdhi_driver = {
 451         .driver         = {
 452                 .name   = "sh_mobile_sdhi",
 453                 .pm     = &tmio_mmc_dev_pm_ops,
 454                 .of_match_table = sh_mobile_sdhi_of_match,
 455         },
 456         .probe          = sh_mobile_sdhi_probe,
 457         .remove         = sh_mobile_sdhi_remove,
 458 };
 459
 460 module_platform_driver(sh_mobile_sdhi_driver);
 461
 462 MODULE_DESCRIPTION("SuperH Mobile SDHI driver");
 463 MODULE_AUTHOR("Magnus Damm");
 464 MODULE_LICENSE("GPL v2");
 465 MODULE_ALIAS("platform:sh_mobile_sdhi");