drivers/mmc/host/sh_mobile_sdhi.c

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