PM / sleep: Drop unused `info' variable
[linux-2.6-block.git] / drivers / mmc / host / sdhci-pxav3.c
1 /*
2  * Copyright (C) 2010 Marvell International Ltd.
3  *              Zhangfei Gao <zhangfei.gao@marvell.com>
4  *              Kevin Wang <dwang4@marvell.com>
5  *              Mingwei Wang <mwwang@marvell.com>
6  *              Philip Rakity <prakity@marvell.com>
7  *              Mark Brown <markb@marvell.com>
8  *
9  * This software is licensed under the terms of the GNU General Public
10  * License version 2, as published by the Free Software Foundation, and
11  * may be copied, distributed, and modified under those terms.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  */
19 #include <linux/err.h>
20 #include <linux/init.h>
21 #include <linux/platform_device.h>
22 #include <linux/clk.h>
23 #include <linux/io.h>
24 #include <linux/gpio.h>
25 #include <linux/mmc/card.h>
26 #include <linux/mmc/host.h>
27 #include <linux/mmc/slot-gpio.h>
28 #include <linux/platform_data/pxa_sdhci.h>
29 #include <linux/slab.h>
30 #include <linux/delay.h>
31 #include <linux/module.h>
32 #include <linux/of.h>
33 #include <linux/of_device.h>
34 #include <linux/of_gpio.h>
35 #include <linux/pm.h>
36 #include <linux/pm_runtime.h>
37 #include <linux/mbus.h>
38
39 #include "sdhci.h"
40 #include "sdhci-pltfm.h"
41
42 #define PXAV3_RPM_DELAY_MS     50
43
44 #define SD_CLOCK_BURST_SIZE_SETUP               0x10A
45 #define SDCLK_SEL       0x100
46 #define SDCLK_DELAY_SHIFT       9
47 #define SDCLK_DELAY_MASK        0x1f
48
49 #define SD_CFG_FIFO_PARAM       0x100
50 #define SDCFG_GEN_PAD_CLK_ON    (1<<6)
51 #define SDCFG_GEN_PAD_CLK_CNT_MASK      0xFF
52 #define SDCFG_GEN_PAD_CLK_CNT_SHIFT     24
53
54 #define SD_SPI_MODE          0x108
55 #define SD_CE_ATA_1          0x10C
56
57 #define SD_CE_ATA_2          0x10E
58 #define SDCE_MISC_INT           (1<<2)
59 #define SDCE_MISC_INT_EN        (1<<1)
60
61 struct sdhci_pxa {
62         struct clk *clk_core;
63         struct clk *clk_io;
64         u8      power_mode;
65         void __iomem *sdio3_conf_reg;
66 };
67
68 /*
69  * These registers are relative to the second register region, for the
70  * MBus bridge.
71  */
72 #define SDHCI_WINDOW_CTRL(i)    (0x80 + ((i) << 3))
73 #define SDHCI_WINDOW_BASE(i)    (0x84 + ((i) << 3))
74 #define SDHCI_MAX_WIN_NUM       8
75
76 /*
77  * Fields below belong to SDIO3 Configuration Register (third register
78  * region for the Armada 38x flavor)
79  */
80
81 #define SDIO3_CONF_CLK_INV      BIT(0)
82 #define SDIO3_CONF_SD_FB_CLK    BIT(2)
83
84 static int mv_conf_mbus_windows(struct platform_device *pdev,
85                                 const struct mbus_dram_target_info *dram)
86 {
87         int i;
88         void __iomem *regs;
89         struct resource *res;
90
91         if (!dram) {
92                 dev_err(&pdev->dev, "no mbus dram info\n");
93                 return -EINVAL;
94         }
95
96         res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
97         if (!res) {
98                 dev_err(&pdev->dev, "cannot get mbus registers\n");
99                 return -EINVAL;
100         }
101
102         regs = ioremap(res->start, resource_size(res));
103         if (!regs) {
104                 dev_err(&pdev->dev, "cannot map mbus registers\n");
105                 return -ENOMEM;
106         }
107
108         for (i = 0; i < SDHCI_MAX_WIN_NUM; i++) {
109                 writel(0, regs + SDHCI_WINDOW_CTRL(i));
110                 writel(0, regs + SDHCI_WINDOW_BASE(i));
111         }
112
113         for (i = 0; i < dram->num_cs; i++) {
114                 const struct mbus_dram_window *cs = dram->cs + i;
115
116                 /* Write size, attributes and target id to control register */
117                 writel(((cs->size - 1) & 0xffff0000) |
118                         (cs->mbus_attr << 8) |
119                         (dram->mbus_dram_target_id << 4) | 1,
120                         regs + SDHCI_WINDOW_CTRL(i));
121                 /* Write base address to base register */
122                 writel(cs->base, regs + SDHCI_WINDOW_BASE(i));
123         }
124
125         iounmap(regs);
126
127         return 0;
128 }
129
130 static int armada_38x_quirks(struct platform_device *pdev,
131                              struct sdhci_host *host)
132 {
133         struct device_node *np = pdev->dev.of_node;
134         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
135         struct sdhci_pxa *pxa = sdhci_pltfm_priv(pltfm_host);
136         struct resource *res;
137
138         host->quirks &= ~SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN;
139         host->quirks |= SDHCI_QUIRK_MISSING_CAPS;
140
141         host->caps = sdhci_readl(host, SDHCI_CAPABILITIES);
142         host->caps1 = sdhci_readl(host, SDHCI_CAPABILITIES_1);
143
144         res = platform_get_resource_byname(pdev, IORESOURCE_MEM,
145                                            "conf-sdio3");
146         if (res) {
147                 pxa->sdio3_conf_reg = devm_ioremap_resource(&pdev->dev, res);
148                 if (IS_ERR(pxa->sdio3_conf_reg))
149                         return PTR_ERR(pxa->sdio3_conf_reg);
150         } else {
151                 /*
152                  * According to erratum 'FE-2946959' both SDR50 and DDR50
153                  * modes require specific clock adjustments in SDIO3
154                  * Configuration register, if the adjustment is not done,
155                  * remove them from the capabilities.
156                  */
157                 host->caps1 &= ~(SDHCI_SUPPORT_SDR50 | SDHCI_SUPPORT_DDR50);
158
159                 dev_warn(&pdev->dev, "conf-sdio3 register not found: disabling SDR50 and DDR50 modes.\nConsider updating your dtb\n");
160         }
161
162         /*
163          * According to erratum 'ERR-7878951' Armada 38x SDHCI
164          * controller has different capabilities than the ones shown
165          * in its registers
166          */
167         if (of_property_read_bool(np, "no-1-8-v")) {
168                 host->caps &= ~SDHCI_CAN_VDD_180;
169                 host->mmc->caps &= ~MMC_CAP_1_8V_DDR;
170         } else {
171                 host->caps &= ~SDHCI_CAN_VDD_330;
172         }
173         host->caps1 &= ~(SDHCI_SUPPORT_SDR104 | SDHCI_USE_SDR50_TUNING);
174
175         return 0;
176 }
177
178 static void pxav3_reset(struct sdhci_host *host, u8 mask)
179 {
180         struct platform_device *pdev = to_platform_device(mmc_dev(host->mmc));
181         struct sdhci_pxa_platdata *pdata = pdev->dev.platform_data;
182
183         sdhci_reset(host, mask);
184
185         if (mask == SDHCI_RESET_ALL) {
186                 /*
187                  * tune timing of read data/command when crc error happen
188                  * no performance impact
189                  */
190                 if (pdata && 0 != pdata->clk_delay_cycles) {
191                         u16 tmp;
192
193                         tmp = readw(host->ioaddr + SD_CLOCK_BURST_SIZE_SETUP);
194                         tmp |= (pdata->clk_delay_cycles & SDCLK_DELAY_MASK)
195                                 << SDCLK_DELAY_SHIFT;
196                         tmp |= SDCLK_SEL;
197                         writew(tmp, host->ioaddr + SD_CLOCK_BURST_SIZE_SETUP);
198                 }
199         }
200 }
201
202 #define MAX_WAIT_COUNT 5
203 static void pxav3_gen_init_74_clocks(struct sdhci_host *host, u8 power_mode)
204 {
205         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
206         struct sdhci_pxa *pxa = sdhci_pltfm_priv(pltfm_host);
207         u16 tmp;
208         int count;
209
210         if (pxa->power_mode == MMC_POWER_UP
211                         && power_mode == MMC_POWER_ON) {
212
213                 dev_dbg(mmc_dev(host->mmc),
214                                 "%s: slot->power_mode = %d,"
215                                 "ios->power_mode = %d\n",
216                                 __func__,
217                                 pxa->power_mode,
218                                 power_mode);
219
220                 /* set we want notice of when 74 clocks are sent */
221                 tmp = readw(host->ioaddr + SD_CE_ATA_2);
222                 tmp |= SDCE_MISC_INT_EN;
223                 writew(tmp, host->ioaddr + SD_CE_ATA_2);
224
225                 /* start sending the 74 clocks */
226                 tmp = readw(host->ioaddr + SD_CFG_FIFO_PARAM);
227                 tmp |= SDCFG_GEN_PAD_CLK_ON;
228                 writew(tmp, host->ioaddr + SD_CFG_FIFO_PARAM);
229
230                 /* slowest speed is about 100KHz or 10usec per clock */
231                 udelay(740);
232                 count = 0;
233
234                 while (count++ < MAX_WAIT_COUNT) {
235                         if ((readw(host->ioaddr + SD_CE_ATA_2)
236                                                 & SDCE_MISC_INT) == 0)
237                                 break;
238                         udelay(10);
239                 }
240
241                 if (count == MAX_WAIT_COUNT)
242                         dev_warn(mmc_dev(host->mmc), "74 clock interrupt not cleared\n");
243
244                 /* clear the interrupt bit if posted */
245                 tmp = readw(host->ioaddr + SD_CE_ATA_2);
246                 tmp |= SDCE_MISC_INT;
247                 writew(tmp, host->ioaddr + SD_CE_ATA_2);
248         }
249         pxa->power_mode = power_mode;
250 }
251
252 static void pxav3_set_uhs_signaling(struct sdhci_host *host, unsigned int uhs)
253 {
254         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
255         struct sdhci_pxa *pxa = sdhci_pltfm_priv(pltfm_host);
256         u16 ctrl_2;
257
258         /*
259          * Set V18_EN -- UHS modes do not work without this.
260          * does not change signaling voltage
261          */
262         ctrl_2 = sdhci_readw(host, SDHCI_HOST_CONTROL2);
263
264         /* Select Bus Speed Mode for host */
265         ctrl_2 &= ~SDHCI_CTRL_UHS_MASK;
266         switch (uhs) {
267         case MMC_TIMING_UHS_SDR12:
268                 ctrl_2 |= SDHCI_CTRL_UHS_SDR12;
269                 break;
270         case MMC_TIMING_UHS_SDR25:
271                 ctrl_2 |= SDHCI_CTRL_UHS_SDR25;
272                 break;
273         case MMC_TIMING_UHS_SDR50:
274                 ctrl_2 |= SDHCI_CTRL_UHS_SDR50 | SDHCI_CTRL_VDD_180;
275                 break;
276         case MMC_TIMING_UHS_SDR104:
277                 ctrl_2 |= SDHCI_CTRL_UHS_SDR104 | SDHCI_CTRL_VDD_180;
278                 break;
279         case MMC_TIMING_MMC_DDR52:
280         case MMC_TIMING_UHS_DDR50:
281                 ctrl_2 |= SDHCI_CTRL_UHS_DDR50 | SDHCI_CTRL_VDD_180;
282                 break;
283         }
284
285         /*
286          * Update SDIO3 Configuration register according to erratum
287          * FE-2946959
288          */
289         if (pxa->sdio3_conf_reg) {
290                 u8 reg_val  = readb(pxa->sdio3_conf_reg);
291
292                 if (uhs == MMC_TIMING_UHS_SDR50 ||
293                     uhs == MMC_TIMING_UHS_DDR50) {
294                         reg_val &= ~SDIO3_CONF_CLK_INV;
295                         reg_val |= SDIO3_CONF_SD_FB_CLK;
296                 } else if (uhs == MMC_TIMING_MMC_HS) {
297                         reg_val &= ~SDIO3_CONF_CLK_INV;
298                         reg_val &= ~SDIO3_CONF_SD_FB_CLK;
299                 } else {
300                         reg_val |= SDIO3_CONF_CLK_INV;
301                         reg_val &= ~SDIO3_CONF_SD_FB_CLK;
302                 }
303                 writeb(reg_val, pxa->sdio3_conf_reg);
304         }
305
306         sdhci_writew(host, ctrl_2, SDHCI_HOST_CONTROL2);
307         dev_dbg(mmc_dev(host->mmc),
308                 "%s uhs = %d, ctrl_2 = %04X\n",
309                 __func__, uhs, ctrl_2);
310 }
311
312 static const struct sdhci_ops pxav3_sdhci_ops = {
313         .set_clock = sdhci_set_clock,
314         .platform_send_init_74_clocks = pxav3_gen_init_74_clocks,
315         .get_max_clock = sdhci_pltfm_clk_get_max_clock,
316         .set_bus_width = sdhci_set_bus_width,
317         .reset = pxav3_reset,
318         .set_uhs_signaling = pxav3_set_uhs_signaling,
319 };
320
321 static struct sdhci_pltfm_data sdhci_pxav3_pdata = {
322         .quirks = SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK
323                 | SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC
324                 | SDHCI_QUIRK_32BIT_ADMA_SIZE
325                 | SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN,
326         .ops = &pxav3_sdhci_ops,
327 };
328
329 #ifdef CONFIG_OF
330 static const struct of_device_id sdhci_pxav3_of_match[] = {
331         {
332                 .compatible = "mrvl,pxav3-mmc",
333         },
334         {
335                 .compatible = "marvell,armada-380-sdhci",
336         },
337         {},
338 };
339 MODULE_DEVICE_TABLE(of, sdhci_pxav3_of_match);
340
341 static struct sdhci_pxa_platdata *pxav3_get_mmc_pdata(struct device *dev)
342 {
343         struct sdhci_pxa_platdata *pdata;
344         struct device_node *np = dev->of_node;
345         u32 clk_delay_cycles;
346
347         pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
348         if (!pdata)
349                 return NULL;
350
351         if (!of_property_read_u32(np, "mrvl,clk-delay-cycles",
352                                   &clk_delay_cycles))
353                 pdata->clk_delay_cycles = clk_delay_cycles;
354
355         return pdata;
356 }
357 #else
358 static inline struct sdhci_pxa_platdata *pxav3_get_mmc_pdata(struct device *dev)
359 {
360         return NULL;
361 }
362 #endif
363
364 static int sdhci_pxav3_probe(struct platform_device *pdev)
365 {
366         struct sdhci_pltfm_host *pltfm_host;
367         struct sdhci_pxa_platdata *pdata = pdev->dev.platform_data;
368         struct device *dev = &pdev->dev;
369         struct device_node *np = pdev->dev.of_node;
370         struct sdhci_host *host = NULL;
371         struct sdhci_pxa *pxa = NULL;
372         const struct of_device_id *match;
373         int ret;
374
375         host = sdhci_pltfm_init(pdev, &sdhci_pxav3_pdata, sizeof(*pxa));
376         if (IS_ERR(host))
377                 return PTR_ERR(host);
378
379         pltfm_host = sdhci_priv(host);
380         pxa = sdhci_pltfm_priv(pltfm_host);
381
382         pxa->clk_io = devm_clk_get(dev, "io");
383         if (IS_ERR(pxa->clk_io))
384                 pxa->clk_io = devm_clk_get(dev, NULL);
385         if (IS_ERR(pxa->clk_io)) {
386                 dev_err(dev, "failed to get io clock\n");
387                 ret = PTR_ERR(pxa->clk_io);
388                 goto err_clk_get;
389         }
390         pltfm_host->clk = pxa->clk_io;
391         clk_prepare_enable(pxa->clk_io);
392
393         pxa->clk_core = devm_clk_get(dev, "core");
394         if (!IS_ERR(pxa->clk_core))
395                 clk_prepare_enable(pxa->clk_core);
396
397         /* enable 1/8V DDR capable */
398         host->mmc->caps |= MMC_CAP_1_8V_DDR;
399
400         if (of_device_is_compatible(np, "marvell,armada-380-sdhci")) {
401                 ret = armada_38x_quirks(pdev, host);
402                 if (ret < 0)
403                         goto err_mbus_win;
404                 ret = mv_conf_mbus_windows(pdev, mv_mbus_dram_info());
405                 if (ret < 0)
406                         goto err_mbus_win;
407         }
408
409         match = of_match_device(of_match_ptr(sdhci_pxav3_of_match), &pdev->dev);
410         if (match) {
411                 ret = mmc_of_parse(host->mmc);
412                 if (ret)
413                         goto err_of_parse;
414                 sdhci_get_of_property(pdev);
415                 pdata = pxav3_get_mmc_pdata(dev);
416                 pdev->dev.platform_data = pdata;
417         } else if (pdata) {
418                 /* on-chip device */
419                 if (pdata->flags & PXA_FLAG_CARD_PERMANENT)
420                         host->mmc->caps |= MMC_CAP_NONREMOVABLE;
421
422                 /* If slot design supports 8 bit data, indicate this to MMC. */
423                 if (pdata->flags & PXA_FLAG_SD_8_BIT_CAPABLE_SLOT)
424                         host->mmc->caps |= MMC_CAP_8_BIT_DATA;
425
426                 if (pdata->quirks)
427                         host->quirks |= pdata->quirks;
428                 if (pdata->quirks2)
429                         host->quirks2 |= pdata->quirks2;
430                 if (pdata->host_caps)
431                         host->mmc->caps |= pdata->host_caps;
432                 if (pdata->host_caps2)
433                         host->mmc->caps2 |= pdata->host_caps2;
434                 if (pdata->pm_caps)
435                         host->mmc->pm_caps |= pdata->pm_caps;
436
437                 if (gpio_is_valid(pdata->ext_cd_gpio)) {
438                         ret = mmc_gpio_request_cd(host->mmc, pdata->ext_cd_gpio,
439                                                   0);
440                         if (ret) {
441                                 dev_err(mmc_dev(host->mmc),
442                                         "failed to allocate card detect gpio\n");
443                                 goto err_cd_req;
444                         }
445                 }
446         }
447
448         pm_runtime_get_noresume(&pdev->dev);
449         pm_runtime_set_active(&pdev->dev);
450         pm_runtime_set_autosuspend_delay(&pdev->dev, PXAV3_RPM_DELAY_MS);
451         pm_runtime_use_autosuspend(&pdev->dev);
452         pm_runtime_enable(&pdev->dev);
453         pm_suspend_ignore_children(&pdev->dev, 1);
454
455         ret = sdhci_add_host(host);
456         if (ret) {
457                 dev_err(&pdev->dev, "failed to add host\n");
458                 goto err_add_host;
459         }
460
461         platform_set_drvdata(pdev, host);
462
463         if (host->mmc->pm_caps & MMC_PM_WAKE_SDIO_IRQ)
464                 device_init_wakeup(&pdev->dev, 1);
465
466         pm_runtime_put_autosuspend(&pdev->dev);
467
468         return 0;
469
470 err_add_host:
471         pm_runtime_disable(&pdev->dev);
472         pm_runtime_put_noidle(&pdev->dev);
473 err_of_parse:
474 err_cd_req:
475 err_mbus_win:
476         clk_disable_unprepare(pxa->clk_io);
477         clk_disable_unprepare(pxa->clk_core);
478 err_clk_get:
479         sdhci_pltfm_free(pdev);
480         return ret;
481 }
482
483 static int sdhci_pxav3_remove(struct platform_device *pdev)
484 {
485         struct sdhci_host *host = platform_get_drvdata(pdev);
486         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
487         struct sdhci_pxa *pxa = sdhci_pltfm_priv(pltfm_host);
488
489         pm_runtime_get_sync(&pdev->dev);
490         pm_runtime_disable(&pdev->dev);
491         pm_runtime_put_noidle(&pdev->dev);
492
493         sdhci_remove_host(host, 1);
494
495         clk_disable_unprepare(pxa->clk_io);
496         clk_disable_unprepare(pxa->clk_core);
497
498         sdhci_pltfm_free(pdev);
499
500         return 0;
501 }
502
503 #ifdef CONFIG_PM_SLEEP
504 static int sdhci_pxav3_suspend(struct device *dev)
505 {
506         int ret;
507         struct sdhci_host *host = dev_get_drvdata(dev);
508
509         pm_runtime_get_sync(dev);
510         ret = sdhci_suspend_host(host);
511         pm_runtime_mark_last_busy(dev);
512         pm_runtime_put_autosuspend(dev);
513
514         return ret;
515 }
516
517 static int sdhci_pxav3_resume(struct device *dev)
518 {
519         int ret;
520         struct sdhci_host *host = dev_get_drvdata(dev);
521
522         pm_runtime_get_sync(dev);
523         ret = sdhci_resume_host(host);
524         pm_runtime_mark_last_busy(dev);
525         pm_runtime_put_autosuspend(dev);
526
527         return ret;
528 }
529 #endif
530
531 #ifdef CONFIG_PM
532 static int sdhci_pxav3_runtime_suspend(struct device *dev)
533 {
534         struct sdhci_host *host = dev_get_drvdata(dev);
535         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
536         struct sdhci_pxa *pxa = sdhci_pltfm_priv(pltfm_host);
537         int ret;
538
539         ret = sdhci_runtime_suspend_host(host);
540         if (ret)
541                 return ret;
542
543         clk_disable_unprepare(pxa->clk_io);
544         if (!IS_ERR(pxa->clk_core))
545                 clk_disable_unprepare(pxa->clk_core);
546
547         return 0;
548 }
549
550 static int sdhci_pxav3_runtime_resume(struct device *dev)
551 {
552         struct sdhci_host *host = dev_get_drvdata(dev);
553         struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
554         struct sdhci_pxa *pxa = sdhci_pltfm_priv(pltfm_host);
555
556         clk_prepare_enable(pxa->clk_io);
557         if (!IS_ERR(pxa->clk_core))
558                 clk_prepare_enable(pxa->clk_core);
559
560         return sdhci_runtime_resume_host(host);
561 }
562 #endif
563
564 #ifdef CONFIG_PM
565 static const struct dev_pm_ops sdhci_pxav3_pmops = {
566         SET_SYSTEM_SLEEP_PM_OPS(sdhci_pxav3_suspend, sdhci_pxav3_resume)
567         SET_RUNTIME_PM_OPS(sdhci_pxav3_runtime_suspend,
568                 sdhci_pxav3_runtime_resume, NULL)
569 };
570
571 #define SDHCI_PXAV3_PMOPS (&sdhci_pxav3_pmops)
572
573 #else
574 #define SDHCI_PXAV3_PMOPS NULL
575 #endif
576
577 static struct platform_driver sdhci_pxav3_driver = {
578         .driver         = {
579                 .name   = "sdhci-pxav3",
580                 .of_match_table = of_match_ptr(sdhci_pxav3_of_match),
581                 .pm     = SDHCI_PXAV3_PMOPS,
582         },
583         .probe          = sdhci_pxav3_probe,
584         .remove         = sdhci_pxav3_remove,
585 };
586
587 module_platform_driver(sdhci_pxav3_driver);
588
589 MODULE_DESCRIPTION("SDHCI driver for pxav3");
590 MODULE_AUTHOR("Marvell International Ltd.");
591 MODULE_LICENSE("GPL v2");
592