ASoC: arizona: Correct handling of FLL theta in synchroniser mode
[linux/fpc-iii.git] / drivers / mmc / host / sdhci-of-esdhc.c
blob239be2fde242fdfc6e0d7607d22fb9aa6c50de88
1 /*
2 * Freescale eSDHC controller driver.
4 * Copyright (c) 2007, 2010, 2012 Freescale Semiconductor, Inc.
5 * Copyright (c) 2009 MontaVista Software, Inc.
7 * Authors: Xiaobo Xie <X.Xie@freescale.com>
8 * Anton Vorontsov <avorontsov@ru.mvista.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or (at
13 * your option) any later version.
16 #include <linux/err.h>
17 #include <linux/io.h>
18 #include <linux/of.h>
19 #include <linux/delay.h>
20 #include <linux/module.h>
21 #include <linux/mmc/host.h>
22 #include "sdhci-pltfm.h"
23 #include "sdhci-esdhc.h"
25 #define VENDOR_V_22 0x12
26 #define VENDOR_V_23 0x13
28 struct sdhci_esdhc {
29 u8 vendor_ver;
30 u8 spec_ver;
33 /**
34 * esdhc_read*_fixup - Fixup the value read from incompatible eSDHC register
35 * to make it compatible with SD spec.
37 * @host: pointer to sdhci_host
38 * @spec_reg: SD spec register address
39 * @value: 32bit eSDHC register value on spec_reg address
41 * In SD spec, there are 8/16/32/64 bits registers, while all of eSDHC
42 * registers are 32 bits. There are differences in register size, register
43 * address, register function, bit position and function between eSDHC spec
44 * and SD spec.
46 * Return a fixed up register value
48 static u32 esdhc_readl_fixup(struct sdhci_host *host,
49 int spec_reg, u32 value)
51 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
52 struct sdhci_esdhc *esdhc = sdhci_pltfm_priv(pltfm_host);
53 u32 ret;
56 * The bit of ADMA flag in eSDHC is not compatible with standard
57 * SDHC register, so set fake flag SDHCI_CAN_DO_ADMA2 when ADMA is
58 * supported by eSDHC.
59 * And for many FSL eSDHC controller, the reset value of field
60 * SDHCI_CAN_DO_ADMA1 is 1, but some of them can't support ADMA,
61 * only these vendor version is greater than 2.2/0x12 support ADMA.
63 if ((spec_reg == SDHCI_CAPABILITIES) && (value & SDHCI_CAN_DO_ADMA1)) {
64 if (esdhc->vendor_ver > VENDOR_V_22) {
65 ret = value | SDHCI_CAN_DO_ADMA2;
66 return ret;
69 ret = value;
70 return ret;
73 static u16 esdhc_readw_fixup(struct sdhci_host *host,
74 int spec_reg, u32 value)
76 u16 ret;
77 int shift = (spec_reg & 0x2) * 8;
79 if (spec_reg == SDHCI_HOST_VERSION)
80 ret = value & 0xffff;
81 else
82 ret = (value >> shift) & 0xffff;
83 return ret;
86 static u8 esdhc_readb_fixup(struct sdhci_host *host,
87 int spec_reg, u32 value)
89 u8 ret;
90 u8 dma_bits;
91 int shift = (spec_reg & 0x3) * 8;
93 ret = (value >> shift) & 0xff;
96 * "DMA select" locates at offset 0x28 in SD specification, but on
97 * P5020 or P3041, it locates at 0x29.
99 if (spec_reg == SDHCI_HOST_CONTROL) {
100 /* DMA select is 22,23 bits in Protocol Control Register */
101 dma_bits = (value >> 5) & SDHCI_CTRL_DMA_MASK;
102 /* fixup the result */
103 ret &= ~SDHCI_CTRL_DMA_MASK;
104 ret |= dma_bits;
106 return ret;
110 * esdhc_write*_fixup - Fixup the SD spec register value so that it could be
111 * written into eSDHC register.
113 * @host: pointer to sdhci_host
114 * @spec_reg: SD spec register address
115 * @value: 8/16/32bit SD spec register value that would be written
116 * @old_value: 32bit eSDHC register value on spec_reg address
118 * In SD spec, there are 8/16/32/64 bits registers, while all of eSDHC
119 * registers are 32 bits. There are differences in register size, register
120 * address, register function, bit position and function between eSDHC spec
121 * and SD spec.
123 * Return a fixed up register value
125 static u32 esdhc_writel_fixup(struct sdhci_host *host,
126 int spec_reg, u32 value, u32 old_value)
128 u32 ret;
131 * Enabling IRQSTATEN[BGESEN] is just to set IRQSTAT[BGE]
132 * when SYSCTL[RSTD] is set for some special operations.
133 * No any impact on other operation.
135 if (spec_reg == SDHCI_INT_ENABLE)
136 ret = value | SDHCI_INT_BLK_GAP;
137 else
138 ret = value;
140 return ret;
143 static u32 esdhc_writew_fixup(struct sdhci_host *host,
144 int spec_reg, u16 value, u32 old_value)
146 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
147 int shift = (spec_reg & 0x2) * 8;
148 u32 ret;
150 switch (spec_reg) {
151 case SDHCI_TRANSFER_MODE:
153 * Postpone this write, we must do it together with a
154 * command write that is down below. Return old value.
156 pltfm_host->xfer_mode_shadow = value;
157 return old_value;
158 case SDHCI_COMMAND:
159 ret = (value << 16) | pltfm_host->xfer_mode_shadow;
160 return ret;
163 ret = old_value & (~(0xffff << shift));
164 ret |= (value << shift);
166 if (spec_reg == SDHCI_BLOCK_SIZE) {
168 * Two last DMA bits are reserved, and first one is used for
169 * non-standard blksz of 4096 bytes that we don't support
170 * yet. So clear the DMA boundary bits.
172 ret &= (~SDHCI_MAKE_BLKSZ(0x7, 0));
174 return ret;
177 static u32 esdhc_writeb_fixup(struct sdhci_host *host,
178 int spec_reg, u8 value, u32 old_value)
180 u32 ret;
181 u32 dma_bits;
182 u8 tmp;
183 int shift = (spec_reg & 0x3) * 8;
186 * eSDHC doesn't have a standard power control register, so we do
187 * nothing here to avoid incorrect operation.
189 if (spec_reg == SDHCI_POWER_CONTROL)
190 return old_value;
192 * "DMA select" location is offset 0x28 in SD specification, but on
193 * P5020 or P3041, it's located at 0x29.
195 if (spec_reg == SDHCI_HOST_CONTROL) {
197 * If host control register is not standard, exit
198 * this function
200 if (host->quirks2 & SDHCI_QUIRK2_BROKEN_HOST_CONTROL)
201 return old_value;
203 /* DMA select is 22,23 bits in Protocol Control Register */
204 dma_bits = (value & SDHCI_CTRL_DMA_MASK) << 5;
205 ret = (old_value & (~(SDHCI_CTRL_DMA_MASK << 5))) | dma_bits;
206 tmp = (value & (~SDHCI_CTRL_DMA_MASK)) |
207 (old_value & SDHCI_CTRL_DMA_MASK);
208 ret = (ret & (~0xff)) | tmp;
210 /* Prevent SDHCI core from writing reserved bits (e.g. HISPD) */
211 ret &= ~ESDHC_HOST_CONTROL_RES;
212 return ret;
215 ret = (old_value & (~(0xff << shift))) | (value << shift);
216 return ret;
219 static u32 esdhc_be_readl(struct sdhci_host *host, int reg)
221 u32 ret;
222 u32 value;
224 value = ioread32be(host->ioaddr + reg);
225 ret = esdhc_readl_fixup(host, reg, value);
227 return ret;
230 static u32 esdhc_le_readl(struct sdhci_host *host, int reg)
232 u32 ret;
233 u32 value;
235 value = ioread32(host->ioaddr + reg);
236 ret = esdhc_readl_fixup(host, reg, value);
238 return ret;
241 static u16 esdhc_be_readw(struct sdhci_host *host, int reg)
243 u16 ret;
244 u32 value;
245 int base = reg & ~0x3;
247 value = ioread32be(host->ioaddr + base);
248 ret = esdhc_readw_fixup(host, reg, value);
249 return ret;
252 static u16 esdhc_le_readw(struct sdhci_host *host, int reg)
254 u16 ret;
255 u32 value;
256 int base = reg & ~0x3;
258 value = ioread32(host->ioaddr + base);
259 ret = esdhc_readw_fixup(host, reg, value);
260 return ret;
263 static u8 esdhc_be_readb(struct sdhci_host *host, int reg)
265 u8 ret;
266 u32 value;
267 int base = reg & ~0x3;
269 value = ioread32be(host->ioaddr + base);
270 ret = esdhc_readb_fixup(host, reg, value);
271 return ret;
274 static u8 esdhc_le_readb(struct sdhci_host *host, int reg)
276 u8 ret;
277 u32 value;
278 int base = reg & ~0x3;
280 value = ioread32(host->ioaddr + base);
281 ret = esdhc_readb_fixup(host, reg, value);
282 return ret;
285 static void esdhc_be_writel(struct sdhci_host *host, u32 val, int reg)
287 u32 value;
289 value = esdhc_writel_fixup(host, reg, val, 0);
290 iowrite32be(value, host->ioaddr + reg);
293 static void esdhc_le_writel(struct sdhci_host *host, u32 val, int reg)
295 u32 value;
297 value = esdhc_writel_fixup(host, reg, val, 0);
298 iowrite32(value, host->ioaddr + reg);
301 static void esdhc_be_writew(struct sdhci_host *host, u16 val, int reg)
303 int base = reg & ~0x3;
304 u32 value;
305 u32 ret;
307 value = ioread32be(host->ioaddr + base);
308 ret = esdhc_writew_fixup(host, reg, val, value);
309 if (reg != SDHCI_TRANSFER_MODE)
310 iowrite32be(ret, host->ioaddr + base);
313 static void esdhc_le_writew(struct sdhci_host *host, u16 val, int reg)
315 int base = reg & ~0x3;
316 u32 value;
317 u32 ret;
319 value = ioread32(host->ioaddr + base);
320 ret = esdhc_writew_fixup(host, reg, val, value);
321 if (reg != SDHCI_TRANSFER_MODE)
322 iowrite32(ret, host->ioaddr + base);
325 static void esdhc_be_writeb(struct sdhci_host *host, u8 val, int reg)
327 int base = reg & ~0x3;
328 u32 value;
329 u32 ret;
331 value = ioread32be(host->ioaddr + base);
332 ret = esdhc_writeb_fixup(host, reg, val, value);
333 iowrite32be(ret, host->ioaddr + base);
336 static void esdhc_le_writeb(struct sdhci_host *host, u8 val, int reg)
338 int base = reg & ~0x3;
339 u32 value;
340 u32 ret;
342 value = ioread32(host->ioaddr + base);
343 ret = esdhc_writeb_fixup(host, reg, val, value);
344 iowrite32(ret, host->ioaddr + base);
348 * For Abort or Suspend after Stop at Block Gap, ignore the ADMA
349 * error(IRQSTAT[ADMAE]) if both Transfer Complete(IRQSTAT[TC])
350 * and Block Gap Event(IRQSTAT[BGE]) are also set.
351 * For Continue, apply soft reset for data(SYSCTL[RSTD]);
352 * and re-issue the entire read transaction from beginning.
354 static void esdhc_of_adma_workaround(struct sdhci_host *host, u32 intmask)
356 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
357 struct sdhci_esdhc *esdhc = sdhci_pltfm_priv(pltfm_host);
358 bool applicable;
359 dma_addr_t dmastart;
360 dma_addr_t dmanow;
362 applicable = (intmask & SDHCI_INT_DATA_END) &&
363 (intmask & SDHCI_INT_BLK_GAP) &&
364 (esdhc->vendor_ver == VENDOR_V_23);
365 if (!applicable)
366 return;
368 host->data->error = 0;
369 dmastart = sg_dma_address(host->data->sg);
370 dmanow = dmastart + host->data->bytes_xfered;
372 * Force update to the next DMA block boundary.
374 dmanow = (dmanow & ~(SDHCI_DEFAULT_BOUNDARY_SIZE - 1)) +
375 SDHCI_DEFAULT_BOUNDARY_SIZE;
376 host->data->bytes_xfered = dmanow - dmastart;
377 sdhci_writel(host, dmanow, SDHCI_DMA_ADDRESS);
380 static int esdhc_of_enable_dma(struct sdhci_host *host)
382 u32 value;
384 value = sdhci_readl(host, ESDHC_DMA_SYSCTL);
385 value |= ESDHC_DMA_SNOOP;
386 sdhci_writel(host, value, ESDHC_DMA_SYSCTL);
387 return 0;
390 static unsigned int esdhc_of_get_max_clock(struct sdhci_host *host)
392 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
394 return pltfm_host->clock;
397 static unsigned int esdhc_of_get_min_clock(struct sdhci_host *host)
399 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
401 return pltfm_host->clock / 256 / 16;
404 static void esdhc_of_set_clock(struct sdhci_host *host, unsigned int clock)
406 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
407 struct sdhci_esdhc *esdhc = sdhci_pltfm_priv(pltfm_host);
408 int pre_div = 1;
409 int div = 1;
410 u32 temp;
412 host->mmc->actual_clock = 0;
414 if (clock == 0)
415 return;
417 /* Workaround to start pre_div at 2 for VNN < VENDOR_V_23 */
418 if (esdhc->vendor_ver < VENDOR_V_23)
419 pre_div = 2;
421 /* Workaround to reduce the clock frequency for p1010 esdhc */
422 if (of_find_compatible_node(NULL, NULL, "fsl,p1010-esdhc")) {
423 if (clock > 20000000)
424 clock -= 5000000;
425 if (clock > 40000000)
426 clock -= 5000000;
429 temp = sdhci_readl(host, ESDHC_SYSTEM_CONTROL);
430 temp &= ~(ESDHC_CLOCK_IPGEN | ESDHC_CLOCK_HCKEN | ESDHC_CLOCK_PEREN
431 | ESDHC_CLOCK_MASK);
432 sdhci_writel(host, temp, ESDHC_SYSTEM_CONTROL);
434 while (host->max_clk / pre_div / 16 > clock && pre_div < 256)
435 pre_div *= 2;
437 while (host->max_clk / pre_div / div > clock && div < 16)
438 div++;
440 dev_dbg(mmc_dev(host->mmc), "desired SD clock: %d, actual: %d\n",
441 clock, host->max_clk / pre_div / div);
442 host->mmc->actual_clock = host->max_clk / pre_div / div;
443 pre_div >>= 1;
444 div--;
446 temp = sdhci_readl(host, ESDHC_SYSTEM_CONTROL);
447 temp |= (ESDHC_CLOCK_IPGEN | ESDHC_CLOCK_HCKEN | ESDHC_CLOCK_PEREN
448 | (div << ESDHC_DIVIDER_SHIFT)
449 | (pre_div << ESDHC_PREDIV_SHIFT));
450 sdhci_writel(host, temp, ESDHC_SYSTEM_CONTROL);
451 mdelay(1);
454 static void esdhc_pltfm_set_bus_width(struct sdhci_host *host, int width)
456 u32 ctrl;
458 ctrl = sdhci_readl(host, ESDHC_PROCTL);
459 ctrl &= (~ESDHC_CTRL_BUSWIDTH_MASK);
460 switch (width) {
461 case MMC_BUS_WIDTH_8:
462 ctrl |= ESDHC_CTRL_8BITBUS;
463 break;
465 case MMC_BUS_WIDTH_4:
466 ctrl |= ESDHC_CTRL_4BITBUS;
467 break;
469 default:
470 break;
473 sdhci_writel(host, ctrl, ESDHC_PROCTL);
476 static void esdhc_reset(struct sdhci_host *host, u8 mask)
478 sdhci_reset(host, mask);
480 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE);
481 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE);
484 #ifdef CONFIG_PM_SLEEP
485 static u32 esdhc_proctl;
486 static int esdhc_of_suspend(struct device *dev)
488 struct sdhci_host *host = dev_get_drvdata(dev);
490 esdhc_proctl = sdhci_readl(host, SDHCI_HOST_CONTROL);
492 return sdhci_suspend_host(host);
495 static int esdhc_of_resume(struct device *dev)
497 struct sdhci_host *host = dev_get_drvdata(dev);
498 int ret = sdhci_resume_host(host);
500 if (ret == 0) {
501 /* Isn't this already done by sdhci_resume_host() ? --rmk */
502 esdhc_of_enable_dma(host);
503 sdhci_writel(host, esdhc_proctl, SDHCI_HOST_CONTROL);
505 return ret;
507 #endif
509 static SIMPLE_DEV_PM_OPS(esdhc_of_dev_pm_ops,
510 esdhc_of_suspend,
511 esdhc_of_resume);
513 static const struct sdhci_ops sdhci_esdhc_be_ops = {
514 .read_l = esdhc_be_readl,
515 .read_w = esdhc_be_readw,
516 .read_b = esdhc_be_readb,
517 .write_l = esdhc_be_writel,
518 .write_w = esdhc_be_writew,
519 .write_b = esdhc_be_writeb,
520 .set_clock = esdhc_of_set_clock,
521 .enable_dma = esdhc_of_enable_dma,
522 .get_max_clock = esdhc_of_get_max_clock,
523 .get_min_clock = esdhc_of_get_min_clock,
524 .adma_workaround = esdhc_of_adma_workaround,
525 .set_bus_width = esdhc_pltfm_set_bus_width,
526 .reset = esdhc_reset,
527 .set_uhs_signaling = sdhci_set_uhs_signaling,
530 static const struct sdhci_ops sdhci_esdhc_le_ops = {
531 .read_l = esdhc_le_readl,
532 .read_w = esdhc_le_readw,
533 .read_b = esdhc_le_readb,
534 .write_l = esdhc_le_writel,
535 .write_w = esdhc_le_writew,
536 .write_b = esdhc_le_writeb,
537 .set_clock = esdhc_of_set_clock,
538 .enable_dma = esdhc_of_enable_dma,
539 .get_max_clock = esdhc_of_get_max_clock,
540 .get_min_clock = esdhc_of_get_min_clock,
541 .adma_workaround = esdhc_of_adma_workaround,
542 .set_bus_width = esdhc_pltfm_set_bus_width,
543 .reset = esdhc_reset,
544 .set_uhs_signaling = sdhci_set_uhs_signaling,
547 static const struct sdhci_pltfm_data sdhci_esdhc_be_pdata = {
548 .quirks = ESDHC_DEFAULT_QUIRKS | SDHCI_QUIRK_BROKEN_CARD_DETECTION
549 | SDHCI_QUIRK_NO_CARD_NO_RESET
550 | SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
551 .ops = &sdhci_esdhc_be_ops,
554 static const struct sdhci_pltfm_data sdhci_esdhc_le_pdata = {
555 .quirks = ESDHC_DEFAULT_QUIRKS | SDHCI_QUIRK_BROKEN_CARD_DETECTION
556 | SDHCI_QUIRK_NO_CARD_NO_RESET
557 | SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC,
558 .ops = &sdhci_esdhc_le_ops,
561 static void esdhc_init(struct platform_device *pdev, struct sdhci_host *host)
563 struct sdhci_pltfm_host *pltfm_host;
564 struct sdhci_esdhc *esdhc;
565 u16 host_ver;
567 pltfm_host = sdhci_priv(host);
568 esdhc = sdhci_pltfm_priv(pltfm_host);
570 host_ver = sdhci_readw(host, SDHCI_HOST_VERSION);
571 esdhc->vendor_ver = (host_ver & SDHCI_VENDOR_VER_MASK) >>
572 SDHCI_VENDOR_VER_SHIFT;
573 esdhc->spec_ver = host_ver & SDHCI_SPEC_VER_MASK;
576 static int sdhci_esdhc_probe(struct platform_device *pdev)
578 struct sdhci_host *host;
579 struct device_node *np;
580 struct sdhci_pltfm_host *pltfm_host;
581 struct sdhci_esdhc *esdhc;
582 int ret;
584 np = pdev->dev.of_node;
586 if (of_get_property(np, "little-endian", NULL))
587 host = sdhci_pltfm_init(pdev, &sdhci_esdhc_le_pdata,
588 sizeof(struct sdhci_esdhc));
589 else
590 host = sdhci_pltfm_init(pdev, &sdhci_esdhc_be_pdata,
591 sizeof(struct sdhci_esdhc));
593 if (IS_ERR(host))
594 return PTR_ERR(host);
596 esdhc_init(pdev, host);
598 sdhci_get_of_property(pdev);
600 pltfm_host = sdhci_priv(host);
601 esdhc = sdhci_pltfm_priv(pltfm_host);
602 if (esdhc->vendor_ver == VENDOR_V_22)
603 host->quirks2 |= SDHCI_QUIRK2_HOST_NO_CMD23;
605 if (esdhc->vendor_ver > VENDOR_V_22)
606 host->quirks &= ~SDHCI_QUIRK_NO_BUSY_IRQ;
608 if (of_device_is_compatible(np, "fsl,p5040-esdhc") ||
609 of_device_is_compatible(np, "fsl,p5020-esdhc") ||
610 of_device_is_compatible(np, "fsl,p4080-esdhc") ||
611 of_device_is_compatible(np, "fsl,p1020-esdhc") ||
612 of_device_is_compatible(np, "fsl,t1040-esdhc") ||
613 of_device_is_compatible(np, "fsl,ls1021a-esdhc"))
614 host->quirks &= ~SDHCI_QUIRK_BROKEN_CARD_DETECTION;
616 if (of_device_is_compatible(np, "fsl,ls1021a-esdhc"))
617 host->quirks |= SDHCI_QUIRK_BROKEN_TIMEOUT_VAL;
619 if (of_device_is_compatible(np, "fsl,p2020-esdhc")) {
621 * Freescale messed up with P2020 as it has a non-standard
622 * host control register
624 host->quirks2 |= SDHCI_QUIRK2_BROKEN_HOST_CONTROL;
627 /* call to generic mmc_of_parse to support additional capabilities */
628 ret = mmc_of_parse(host->mmc);
629 if (ret)
630 goto err;
632 mmc_of_parse_voltage(np, &host->ocr_mask);
634 ret = sdhci_add_host(host);
635 if (ret)
636 goto err;
638 return 0;
639 err:
640 sdhci_pltfm_free(pdev);
641 return ret;
644 static const struct of_device_id sdhci_esdhc_of_match[] = {
645 { .compatible = "fsl,mpc8379-esdhc" },
646 { .compatible = "fsl,mpc8536-esdhc" },
647 { .compatible = "fsl,esdhc" },
650 MODULE_DEVICE_TABLE(of, sdhci_esdhc_of_match);
652 static struct platform_driver sdhci_esdhc_driver = {
653 .driver = {
654 .name = "sdhci-esdhc",
655 .of_match_table = sdhci_esdhc_of_match,
656 .pm = &esdhc_of_dev_pm_ops,
658 .probe = sdhci_esdhc_probe,
659 .remove = sdhci_pltfm_unregister,
662 module_platform_driver(sdhci_esdhc_driver);
664 MODULE_DESCRIPTION("SDHCI OF driver for Freescale MPC eSDHC");
665 MODULE_AUTHOR("Xiaobo Xie <X.Xie@freescale.com>, "
666 "Anton Vorontsov <avorontsov@ru.mvista.com>");
667 MODULE_LICENSE("GPL v2");