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