4 * Copyright (C) 2009 Magnus Damm
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.
10 * Based on "Compaq ASIC3 support":
12 * Copyright 2001 Compaq Computer Corporation.
13 * Copyright 2004-2005 Phil Blundell
14 * Copyright 2007-2008 OpenedHand Ltd.
16 * Authors: Phil Blundell <pb@handhelds.org>,
17 * Samuel Ortiz <sameo@openedhand.com>
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>
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;
45 static const struct sh_mobile_sdhi_of_data sh_mobile_sdhi_of_cfg[] = {
47 .tmio_flags = TMIO_MMC_HAS_IDLE_WAIT,
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 |
54 .capabilities = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
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 |
60 .capabilities = MMC_CAP_SD_HIGHSPEED | MMC_CAP_SDIO_IRQ,
61 .dma_rx_offset = 0x2000,
64 static const struct of_device_id sh_mobile_sdhi_of_match[] = {
65 { .compatible = "renesas,sdhi-shmobile" },
66 { .compatible = "renesas,sdhi-sh7372" },
67 { .compatible = "renesas,sdhi-sh73a0", .data = &sh_mobile_sdhi_of_cfg[0], },
68 { .compatible = "renesas,sdhi-r8a73a4", .data = &sh_mobile_sdhi_of_cfg[0], },
69 { .compatible = "renesas,sdhi-r8a7740", .data = &sh_mobile_sdhi_of_cfg[0], },
70 { .compatible = "renesas,sdhi-r8a7778", .data = &of_rcar_gen1_compatible, },
71 { .compatible = "renesas,sdhi-r8a7779", .data = &of_rcar_gen1_compatible, },
72 { .compatible = "renesas,sdhi-r8a7790", .data = &of_rcar_gen2_compatible, },
73 { .compatible = "renesas,sdhi-r8a7791", .data = &of_rcar_gen2_compatible, },
74 { .compatible = "renesas,sdhi-r8a7792", .data = &of_rcar_gen2_compatible, },
75 { .compatible = "renesas,sdhi-r8a7793", .data = &of_rcar_gen2_compatible, },
76 { .compatible = "renesas,sdhi-r8a7794", .data = &of_rcar_gen2_compatible, },
79 MODULE_DEVICE_TABLE(of, sh_mobile_sdhi_of_match);
81 struct sh_mobile_sdhi {
83 struct tmio_mmc_data mmc_data;
84 struct tmio_mmc_dma dma_priv;
87 static int sh_mobile_sdhi_clk_enable(struct platform_device *pdev, unsigned int *f)
89 struct mmc_host *mmc = platform_get_drvdata(pdev);
90 struct tmio_mmc_host *host = mmc_priv(mmc);
91 struct sh_mobile_sdhi *priv = container_of(host->pdata, struct sh_mobile_sdhi, mmc_data);
92 int ret = clk_prepare_enable(priv->clk);
96 *f = clk_get_rate(priv->clk);
100 static void sh_mobile_sdhi_clk_disable(struct platform_device *pdev)
102 struct mmc_host *mmc = platform_get_drvdata(pdev);
103 struct tmio_mmc_host *host = mmc_priv(mmc);
104 struct sh_mobile_sdhi *priv = container_of(host->pdata, struct sh_mobile_sdhi, mmc_data);
105 clk_disable_unprepare(priv->clk);
108 static int sh_mobile_sdhi_wait_idle(struct tmio_mmc_host *host)
112 while (--timeout && !(sd_ctrl_read16(host, CTL_STATUS2) & (1 << 13)))
116 dev_warn(&host->pdev->dev, "timeout waiting for SD bus idle\n");
123 static int sh_mobile_sdhi_write16_hook(struct tmio_mmc_host *host, int addr)
128 case CTL_STOP_INTERNAL_ACTION:
129 case CTL_XFER_BLK_COUNT:
130 case CTL_SD_CARD_CLK_CTL:
131 case CTL_SD_XFER_LEN:
132 case CTL_SD_MEM_CARD_OPT:
133 case CTL_TRANSACTION_CTL:
135 return sh_mobile_sdhi_wait_idle(host);
141 static int sh_mobile_sdhi_multi_io_quirk(struct mmc_card *card,
142 unsigned int direction, int blk_size)
145 * In Renesas controllers, when performing a
146 * multiple block read of one or two blocks,
147 * depending on the timing with which the
148 * response register is read, the response
149 * value may not be read properly.
150 * Use single block read for this HW bug
152 if ((direction == MMC_DATA_READ) &&
159 static void sh_mobile_sdhi_cd_wakeup(const struct platform_device *pdev)
161 mmc_detect_change(platform_get_drvdata(pdev), msecs_to_jiffies(100));
164 static const struct sh_mobile_sdhi_ops sdhi_ops = {
165 .cd_wakeup = sh_mobile_sdhi_cd_wakeup,
168 static int sh_mobile_sdhi_probe(struct platform_device *pdev)
170 const struct of_device_id *of_id =
171 of_match_device(sh_mobile_sdhi_of_match, &pdev->dev);
172 struct sh_mobile_sdhi *priv;
173 struct tmio_mmc_data *mmc_data;
174 struct sh_mobile_sdhi_info *p = pdev->dev.platform_data;
175 struct tmio_mmc_host *host;
176 struct resource *res;
178 bool multiplexed_isr = true;
179 struct tmio_mmc_dma *dma_priv;
182 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
186 priv = devm_kzalloc(&pdev->dev, sizeof(struct sh_mobile_sdhi), GFP_KERNEL);
188 dev_err(&pdev->dev, "kzalloc failed\n");
192 mmc_data = &priv->mmc_data;
193 dma_priv = &priv->dma_priv;
197 ret = p->init(pdev, &sdhi_ops);
203 priv->clk = devm_clk_get(&pdev->dev, NULL);
204 if (IS_ERR(priv->clk)) {
205 ret = PTR_ERR(priv->clk);
206 dev_err(&pdev->dev, "cannot get clock: %d\n", ret);
210 host = tmio_mmc_host_alloc(pdev);
216 host->dma = dma_priv;
217 host->write16_hook = sh_mobile_sdhi_write16_hook;
218 host->clk_enable = sh_mobile_sdhi_clk_enable;
219 host->clk_disable = sh_mobile_sdhi_clk_disable;
220 host->multi_io_quirk = sh_mobile_sdhi_multi_io_quirk;
221 /* SD control register space size is 0x100, 0x200 for bus_shift=1 */
222 host->bus_shift = resource_size(res) >> 9;
224 mmc_data->capabilities = MMC_CAP_MMC_HIGHSPEED;
226 mmc_data->flags = p->tmio_flags;
227 mmc_data->ocr_mask = p->tmio_ocr_mask;
228 mmc_data->capabilities |= p->tmio_caps;
229 mmc_data->capabilities2 |= p->tmio_caps2;
230 mmc_data->cd_gpio = p->cd_gpio;
232 if (p->dma_slave_tx > 0 && p->dma_slave_rx > 0) {
234 * Yes, we have to provide slave IDs twice to TMIO:
235 * once as a filter parameter and once for channel
236 * configuration as an explicit slave ID
238 dma_priv->chan_priv_tx = (void *)p->dma_slave_tx;
239 dma_priv->chan_priv_rx = (void *)p->dma_slave_rx;
240 dma_priv->slave_id_tx = p->dma_slave_tx;
241 dma_priv->slave_id_rx = p->dma_slave_rx;
244 dma_priv->filter = shdma_chan_filter;
246 mmc_data->alignment_shift = 1; /* 2-byte alignment */
249 * All SDHI blocks support 2-byte and larger block sizes in 4-bit
252 mmc_data->flags |= TMIO_MMC_BLKSZ_2BYTES;
255 * All SDHI blocks support SDIO IRQ signalling.
257 mmc_data->flags |= TMIO_MMC_SDIO_IRQ;
260 * All SDHI have CMD12 controll bit
262 mmc_data->flags |= TMIO_MMC_HAVE_CMD12_CTRL;
265 * All SDHI need SDIO_INFO1 reserved bit
267 mmc_data->flags |= TMIO_MMC_SDIO_STATUS_QUIRK;
270 * All SDHI have DMA control register
272 mmc_data->flags |= TMIO_MMC_HAVE_CTL_DMA_REG;
274 if (of_id && of_id->data) {
275 const struct sh_mobile_sdhi_of_data *of_data = of_id->data;
276 mmc_data->flags |= of_data->tmio_flags;
277 mmc_data->capabilities |= of_data->capabilities;
278 mmc_data->capabilities2 |= of_data->capabilities2;
279 dma_priv->dma_rx_offset = of_data->dma_rx_offset;
282 ret = tmio_mmc_host_probe(host, mmc_data);
288 * this Workaround can be more clever method
290 ver = sd_ctrl_read16(host, CTL_VERSION);
292 sd_ctrl_write16(host, EXT_ACC, 1);
295 * Allow one or more specific (named) ISRs or
296 * one or more multiplexed (un-named) ISRs.
299 irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_CARD_DETECT);
301 multiplexed_isr = false;
302 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_card_detect_irq, 0,
303 dev_name(&pdev->dev), host);
308 irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_SDIO);
310 multiplexed_isr = false;
311 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_sdio_irq, 0,
312 dev_name(&pdev->dev), host);
317 irq = platform_get_irq_byname(pdev, SH_MOBILE_SDHI_IRQ_SDCARD);
319 multiplexed_isr = false;
320 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_sdcard_irq, 0,
321 dev_name(&pdev->dev), host);
324 } else if (!multiplexed_isr) {
326 "Principal SD-card IRQ is missing among named interrupts\n");
331 if (multiplexed_isr) {
333 irq = platform_get_irq(pdev, i);
337 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq, 0,
338 dev_name(&pdev->dev), host);
343 /* There must be at least one IRQ source */
350 dev_info(&pdev->dev, "%s base at 0x%08lx clock rate %u MHz\n",
351 mmc_hostname(host->mmc), (unsigned long)
352 (platform_get_resource(pdev, IORESOURCE_MEM, 0)->start),
353 host->mmc->f_max / 1000000);
358 tmio_mmc_host_remove(host);
360 tmio_mmc_host_free(host);
368 static int sh_mobile_sdhi_remove(struct platform_device *pdev)
370 struct mmc_host *mmc = platform_get_drvdata(pdev);
371 struct tmio_mmc_host *host = mmc_priv(mmc);
372 struct sh_mobile_sdhi_info *p = pdev->dev.platform_data;
374 tmio_mmc_host_remove(host);
382 static const struct dev_pm_ops tmio_mmc_dev_pm_ops = {
383 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
384 pm_runtime_force_resume)
385 SET_RUNTIME_PM_OPS(tmio_mmc_host_runtime_suspend,
386 tmio_mmc_host_runtime_resume,
390 static struct platform_driver sh_mobile_sdhi_driver = {
392 .name = "sh_mobile_sdhi",
393 .pm = &tmio_mmc_dev_pm_ops,
394 .of_match_table = sh_mobile_sdhi_of_match,
396 .probe = sh_mobile_sdhi_probe,
397 .remove = sh_mobile_sdhi_remove,
400 module_platform_driver(sh_mobile_sdhi_driver);
402 MODULE_DESCRIPTION("SuperH Mobile SDHI driver");
403 MODULE_AUTHOR("Magnus Damm");
404 MODULE_LICENSE("GPL v2");
405 MODULE_ALIAS("platform:sh_mobile_sdhi");