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