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