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