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 struct sh_mobile_sdhi_of_data {
  39         unsigned long tmio_flags;
  40         unsigned long capabilities;
  41         unsigned long capabilities2;
  42 };
  43
  44 static const struct sh_mobile_sdhi_of_data sh_mobile_sdhi_of_cfg[] = {
  45         {
  46                 .tmio_flags = TMIO_MMC_HAS_IDLE_WAIT,
  47         },
  48 };
  49
  50 static const struct sh_mobile_sdhi_of_data of_rcar_gen1_compatible = {
  51         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE,
  52         .capabilities   = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
  53 };
  54
  55 static const struct sh_mobile_sdhi_of_data of_rcar_gen2_compatible = {
  56         .tmio_flags     = TMIO_MMC_HAS_IDLE_WAIT | TMIO_MMC_WRPROTECT_DISABLE,
  57         .capabilities   = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
  58         .capabilities2  = MMC_CAP2_NO_MULTI_READ,
  59 };
  60
  61 static const struct of_device_id sh_mobile_sdhi_of_match[] = {
  62         { .compatible = "renesas,sdhi-shmobile" },
  63         { .compatible = "renesas,sdhi-sh7372" },
  64         { .compatible = "renesas,sdhi-sh73a0", .data = &sh_mobile_sdhi_of_cfg[0], },
  65         { .compatible = "renesas,sdhi-r8a73a4", .data = &sh_mobile_sdhi_of_cfg[0], },
  66         { .compatible = "renesas,sdhi-r8a7740", .data = &sh_mobile_sdhi_of_cfg[0], },
  67         { .compatible = "renesas,sdhi-r8a7778", .data = &of_rcar_gen1_compatible, },
  68         { .compatible = "renesas,sdhi-r8a7779", .data = &of_rcar_gen1_compatible, },
  69         { .compatible = "renesas,sdhi-r8a7790", .data = &of_rcar_gen2_compatible, },
  70         { .compatible = "renesas,sdhi-r8a7791", .data = &of_rcar_gen2_compatible, },
  71         {},
  72 };
  73 MODULE_DEVICE_TABLE(of, sh_mobile_sdhi_of_match);
  74
  75 struct sh_mobile_sdhi {
  76         struct clk *clk;
  77         struct tmio_mmc_data mmc_data;
  78         struct tmio_mmc_dma dma_priv;
  79 };
  80
  81 static int sh_mobile_sdhi_clk_enable(struct platform_device *pdev, unsigned int *f)
  82 {
  83         struct mmc_host *mmc = platform_get_drvdata(pdev);
  84         struct tmio_mmc_host *host = mmc_priv(mmc);
  85         struct sh_mobile_sdhi *priv = container_of(host->pdata, struct sh_mobile_sdhi, mmc_data);
  86         int ret = clk_prepare_enable(priv->clk);
  87         if (ret < 0)
  88                 return ret;
  89
  90         *f = clk_get_rate(priv->clk);
  91         return 0;
  92 }
  93
  94 static void sh_mobile_sdhi_clk_disable(struct platform_device *pdev)
  95 {
  96         struct mmc_host *mmc = platform_get_drvdata(pdev);
  97         struct tmio_mmc_host *host = mmc_priv(mmc);
  98         struct sh_mobile_sdhi *priv = container_of(host->pdata, struct sh_mobile_sdhi, mmc_data);
  99         clk_disable_unprepare(priv->clk);
 100 }
 101
 102 static int sh_mobile_sdhi_wait_idle(struct tmio_mmc_host *host)
 103 {
 104         int timeout = 1000;
 105
 106         while (--timeout && !(sd_ctrl_read16(host, CTL_STATUS2) & (1 << 13)))
 107                 udelay(1);
 108
 109         if (!timeout) {
 110                 dev_warn(host->pdata->dev, "timeout waiting for SD bus idle\n");
 111                 return -EBUSY;
 112         }
 113
 114         return 0;
 115 }
 116
 117 static int sh_mobile_sdhi_write16_hook(struct tmio_mmc_host *host, int addr)
 118 {
 119         switch (addr)
 120         {
 121         case CTL_SD_CMD:
 122         case CTL_STOP_INTERNAL_ACTION:
 123         case CTL_XFER_BLK_COUNT:
 124         case CTL_SD_CARD_CLK_CTL:
 125         case CTL_SD_XFER_LEN:
 126         case CTL_SD_MEM_CARD_OPT:
 127         case CTL_TRANSACTION_CTL:
 128         case CTL_DMA_ENABLE:
 129                 return sh_mobile_sdhi_wait_idle(host);
 130         }
 131
 132         return 0;
 133 }
 134
 135 static void sh_mobile_sdhi_cd_wakeup(const struct platform_device *pdev)
 136 {
 137         mmc_detect_change(platform_get_drvdata(pdev), msecs_to_jiffies(100));
 138 }
 139
 140 static const struct sh_mobile_sdhi_ops sdhi_ops = {
 141         .cd_wakeup = sh_mobile_sdhi_cd_wakeup,
 142 };
 143
 144 static int sh_mobile_sdhi_probe(struct platform_device *pdev)
 145 {
 146         const struct of_device_id *of_id =
 147                 of_match_device(sh_mobile_sdhi_of_match, &pdev->dev);
 148         struct sh_mobile_sdhi *priv;
 149         struct tmio_mmc_data *mmc_data;
 150         struct sh_mobile_sdhi_info *p = pdev->dev.platform_data;
 151         struct tmio_mmc_host *host;
 152         struct resource *res;
 153         int irq, ret, i = 0;
 154         bool multiplexed_isr = true;
 155         struct tmio_mmc_dma *dma_priv;
 156         u16 ver;
 157
 158         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 159         if (!res)
 160                 return -EINVAL;
 161
 162         priv = devm_kzalloc(&pdev->dev, sizeof(struct sh_mobile_sdhi), GFP_KERNEL);
 163         if (priv == NULL) {
 164                 dev_err(&pdev->dev, "kzalloc failed\n");
 165                 return -ENOMEM;
 166         }
 167
 168         mmc_data = &priv->mmc_data;
 169         dma_priv = &priv->dma_priv;
 170
 171         if (p) {
 172                 if (p->init) {
 173                         ret = p->init(pdev, &sdhi_ops);
 174                         if (ret)
 175                                 return ret;
 176                 }
 177         }
 178
 179         priv->clk = devm_clk_get(&pdev->dev, NULL);
 180         if (IS_ERR(priv->clk)) {
 181                 ret = PTR_ERR(priv->clk);
 182                 dev_err(&pdev->dev, "cannot get clock: %d\n", ret);
 183                 goto eclkget;
 184         }
 185
 186         mmc_data->clk_enable = sh_mobile_sdhi_clk_enable;
 187         mmc_data->clk_disable = sh_mobile_sdhi_clk_disable;
 188         mmc_data->capabilities = MMC_CAP_MMC_HIGHSPEED;
 189         mmc_data->write16_hook = sh_mobile_sdhi_write16_hook;
 190         if (p) {
 191                 mmc_data->flags = p->tmio_flags;
 192                 mmc_data->ocr_mask = p->tmio_ocr_mask;
 193                 mmc_data->capabilities |= p->tmio_caps;
 194                 mmc_data->capabilities2 |= p->tmio_caps2;
 195                 mmc_data->cd_gpio = p->cd_gpio;
 196
 197                 if (p->dma_slave_tx > 0 && p->dma_slave_rx > 0) {
 198                         /*
 199                          * Yes, we have to provide slave IDs twice to TMIO:
 200                          * once as a filter parameter and once for channel
 201                          * configuration as an explicit slave ID
 202                          */
 203                         dma_priv->chan_priv_tx = (void *)p->dma_slave_tx;
 204                         dma_priv->chan_priv_rx = (void *)p->dma_slave_rx;
 205                         dma_priv->slave_id_tx = p->dma_slave_tx;
 206                         dma_priv->slave_id_rx = p->dma_slave_rx;
 207                 }
 208         }
 209
 210         dma_priv->alignment_shift = 1; /* 2-byte alignment */
 211         dma_priv->filter = shdma_chan_filter;
 212
 213         mmc_data->dma = dma_priv;
 214
 215         /*
 216          * All SDHI blocks support 2-byte and larger block sizes in 4-bit
 217          * bus width mode.
 218          */
 219         mmc_data->flags |= TMIO_MMC_BLKSZ_2BYTES;
 220
 221         /*
 222          * All SDHI blocks support SDIO IRQ signalling.
 223          */
 224         mmc_data->flags |= TMIO_MMC_SDIO_IRQ;
 225
 226         if (of_id && of_id->data) {
 227                 const struct sh_mobile_sdhi_of_data *of_data = of_id->data;
 228                 mmc_data->flags |= of_data->tmio_flags;
 229                 mmc_data->capabilities |= of_data->capabilities;
 230                 mmc_data->capabilities2 |= of_data->capabilities2;
 231         }
 232
 233         /* SD control register space size is 0x100, 0x200 for bus_shift=1 */
 234         mmc_data->bus_shift = resource_size(res) >> 9;
 235
 236         ret = tmio_mmc_host_probe(&host, pdev, mmc_data);
 237         if (ret < 0)
 238                 goto eprobe;
 239
 240         /*
 241          * FIXME:
 242          * this Workaround can be more clever method
 243          */
 244         ver = sd_ctrl_read16(host, CTL_VERSION);
 245         if (ver == 0xCB0D)
 246                 sd_ctrl_write16(host, EXT_ACC, 1);
 247
 248         /*
 249          * Allow one or more specific (named) ISRs or
 250          * one or more multiplexed (un-named) ISRs.
 251          */
 252
 253         irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_CARD_DETECT);
 254         if (irq >= 0) {
 255                 multiplexed_isr = false;
 256                 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_card_detect_irq, 0,
 257                                   dev_name(&pdev->dev), host);
 258                 if (ret)
 259                         goto eirq;
 260         }
 261
 262         irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_SDIO);
 263         if (irq >= 0) {
 264                 multiplexed_isr = false;
 265                 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_sdio_irq, 0,
 266                                   dev_name(&pdev->dev), host);
 267                 if (ret)
 268                         goto eirq;
 269         }
 270
 271         irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_SDCARD);
 272         if (irq >= 0) {
 273                 multiplexed_isr = false;
 274                 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_sdcard_irq, 0,
 275                                   dev_name(&pdev->dev), host);
 276                 if (ret)
 277                         goto eirq;
 278         } else if (!multiplexed_isr) {
 279                 dev_err(&pdev->dev,
 280                         "Principal SD-card IRQ is missing among named interrupts\n");
 281                 ret = irq;
 282                 goto eirq;
 283         }
 284
 285         if (multiplexed_isr) {
 286                 while (1) {
 287                         irq = platform_get_irq(pdev, i);
 288                         if (irq < 0)
 289                                 break;
 290                         i++;
 291                         ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq, 0,
 292                                           dev_name(&pdev->dev), host);
 293                         if (ret)
 294                                 goto eirq;
 295                 }
 296
 297                 /* There must be at least one IRQ source */
 298                 if (!i) {
 299                         ret = irq;
 300                         goto eirq;
 301                 }
 302         }
 303
 304         dev_info(&pdev->dev, "%s base at 0x%08lx clock rate %u MHz\n",
 305                  mmc_hostname(host->mmc), (unsigned long)
 306                  (platform_get_resource(pdev, IORESOURCE_MEM, 0)->start),
 307                  host->mmc->f_max / 1000000);
 308
 309         return ret;
 310
 311 eirq:
 312         tmio_mmc_host_remove(host);
 313 eprobe:
 314 eclkget:
 315         if (p && p->cleanup)
 316                 p->cleanup(pdev);
 317         return ret;
 318 }
 319
 320 static int sh_mobile_sdhi_remove(struct platform_device *pdev)
 321 {
 322         struct mmc_host *mmc = platform_get_drvdata(pdev);
 323         struct tmio_mmc_host *host = mmc_priv(mmc);
 324         struct sh_mobile_sdhi_info *p = pdev->dev.platform_data;
 325
 326         tmio_mmc_host_remove(host);
 327
 328         if (p && p->cleanup)
 329                 p->cleanup(pdev);
 330
 331         return 0;
 332 }
 333
 334 static const struct dev_pm_ops tmio_mmc_dev_pm_ops = {
 335         SET_SYSTEM_SLEEP_PM_OPS(tmio_mmc_host_suspend, tmio_mmc_host_resume)
 336         SET_RUNTIME_PM_OPS(tmio_mmc_host_runtime_suspend,
 337                         tmio_mmc_host_runtime_resume,
 338                         NULL)
 339 };
 340
 341 static struct platform_driver sh_mobile_sdhi_driver = {
 342         .driver         = {
 343                 .name   = "sh_mobile_sdhi",
 344                 .owner  = THIS_MODULE,
 345                 .pm     = &tmio_mmc_dev_pm_ops,
 346                 .of_match_table = sh_mobile_sdhi_of_match,
 347         },
 348         .probe          = sh_mobile_sdhi_probe,
 349         .remove         = sh_mobile_sdhi_remove,
 350 };
 351
 352 module_platform_driver(sh_mobile_sdhi_driver);
 353
 354 MODULE_DESCRIPTION("SuperH Mobile SDHI driver");
 355 MODULE_AUTHOR("Magnus Damm");
 356 MODULE_LICENSE("GPL v2");
 357 MODULE_ALIAS("platform:sh_mobile_sdhi");