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