2 * linux/drivers/mmc/host/pxa.c - PXA MMCI driver
4 * Copyright (C) 2003 Russell King, All Rights Reserved.
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 * This hardware is really sick:
11 * - No way to clear interrupts.
12 * - Have to turn off the clock whenever we touch the device.
13 * - Doesn't tell you how many data blocks were transferred.
16 * 1 and 3 byte data transfers not supported
17 * max block length up to 1023
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/ioport.h>
22 #include <linux/platform_device.h>
23 #include <linux/delay.h>
24 #include <linux/interrupt.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/clk.h>
27 #include <linux/err.h>
28 #include <linux/mmc/host.h>
31 #include <asm/sizes.h>
33 #include <mach/hardware.h>
39 #define DRIVER_NAME "pxa2xx-mci"
42 #define CLKRT_OFF (~0)
50 unsigned long clkrate;
56 unsigned int power_mode;
57 struct pxamci_platform_data *pdata;
59 struct mmc_request *mrq;
60 struct mmc_command *cmd;
61 struct mmc_data *data;
64 struct pxa_dma_desc *sg_cpu;
68 unsigned int dma_drcmrrx;
69 unsigned int dma_drcmrtx;
72 static void pxamci_stop_clock(struct pxamci_host *host)
74 if (readl(host->base + MMC_STAT) & STAT_CLK_EN) {
75 unsigned long timeout = 10000;
78 writel(STOP_CLOCK, host->base + MMC_STRPCL);
81 v = readl(host->base + MMC_STAT);
82 if (!(v & STAT_CLK_EN))
88 dev_err(mmc_dev(host->mmc), "unable to stop clock\n");
92 static void pxamci_enable_irq(struct pxamci_host *host, unsigned int mask)
96 spin_lock_irqsave(&host->lock, flags);
98 writel(host->imask, host->base + MMC_I_MASK);
99 spin_unlock_irqrestore(&host->lock, flags);
102 static void pxamci_disable_irq(struct pxamci_host *host, unsigned int mask)
106 spin_lock_irqsave(&host->lock, flags);
108 writel(host->imask, host->base + MMC_I_MASK);
109 spin_unlock_irqrestore(&host->lock, flags);
112 static void pxamci_setup_data(struct pxamci_host *host, struct mmc_data *data)
114 unsigned int nob = data->blocks;
115 unsigned long long clks;
116 unsigned int timeout;
123 if (data->flags & MMC_DATA_STREAM)
126 writel(nob, host->base + MMC_NOB);
127 writel(data->blksz, host->base + MMC_BLKLEN);
129 clks = (unsigned long long)data->timeout_ns * host->clkrate;
130 do_div(clks, 1000000000UL);
131 timeout = (unsigned int)clks + (data->timeout_clks << host->clkrt);
132 writel((timeout + 255) / 256, host->base + MMC_RDTO);
134 if (data->flags & MMC_DATA_READ) {
135 host->dma_dir = DMA_FROM_DEVICE;
136 dcmd = DCMD_INCTRGADDR | DCMD_FLOWTRG;
137 DRCMR(host->dma_drcmrtx) = 0;
138 DRCMR(host->dma_drcmrrx) = host->dma | DRCMR_MAPVLD;
140 host->dma_dir = DMA_TO_DEVICE;
141 dcmd = DCMD_INCSRCADDR | DCMD_FLOWSRC;
142 DRCMR(host->dma_drcmrrx) = 0;
143 DRCMR(host->dma_drcmrtx) = host->dma | DRCMR_MAPVLD;
146 dcmd |= DCMD_BURST32 | DCMD_WIDTH1;
148 host->dma_len = dma_map_sg(mmc_dev(host->mmc), data->sg, data->sg_len,
151 for (i = 0; i < host->dma_len; i++) {
152 unsigned int length = sg_dma_len(&data->sg[i]);
153 host->sg_cpu[i].dcmd = dcmd | length;
154 if (length & 31 && !(data->flags & MMC_DATA_READ))
155 host->sg_cpu[i].dcmd |= DCMD_ENDIRQEN;
156 /* Not aligned to 8-byte boundary? */
157 if (sg_dma_address(&data->sg[i]) & 0x7)
159 if (data->flags & MMC_DATA_READ) {
160 host->sg_cpu[i].dsadr = host->res->start + MMC_RXFIFO;
161 host->sg_cpu[i].dtadr = sg_dma_address(&data->sg[i]);
163 host->sg_cpu[i].dsadr = sg_dma_address(&data->sg[i]);
164 host->sg_cpu[i].dtadr = host->res->start + MMC_TXFIFO;
166 host->sg_cpu[i].ddadr = host->sg_dma + (i + 1) *
167 sizeof(struct pxa_dma_desc);
169 host->sg_cpu[host->dma_len - 1].ddadr = DDADR_STOP;
173 * The PXA27x DMA controller encounters overhead when working with
174 * unaligned (to 8-byte boundaries) data, so switch on byte alignment
175 * mode only if we have unaligned data.
178 DALGN |= (1 << host->dma);
180 DALGN &= ~(1 << host->dma);
181 DDADR(host->dma) = host->sg_dma;
184 * workaround for erratum #91:
185 * only start DMA now if we are doing a read,
186 * otherwise we wait until CMD/RESP has finished
187 * before starting DMA.
189 if (!cpu_is_pxa27x() || data->flags & MMC_DATA_READ)
190 DCSR(host->dma) = DCSR_RUN;
193 static void pxamci_start_cmd(struct pxamci_host *host, struct mmc_command *cmd, unsigned int cmdat)
195 WARN_ON(host->cmd != NULL);
198 if (cmd->flags & MMC_RSP_BUSY)
201 #define RSP_TYPE(x) ((x) & ~(MMC_RSP_BUSY|MMC_RSP_OPCODE))
202 switch (RSP_TYPE(mmc_resp_type(cmd))) {
203 case RSP_TYPE(MMC_RSP_R1): /* r1, r1b, r6, r7 */
204 cmdat |= CMDAT_RESP_SHORT;
206 case RSP_TYPE(MMC_RSP_R3):
207 cmdat |= CMDAT_RESP_R3;
209 case RSP_TYPE(MMC_RSP_R2):
210 cmdat |= CMDAT_RESP_R2;
216 writel(cmd->opcode, host->base + MMC_CMD);
217 writel(cmd->arg >> 16, host->base + MMC_ARGH);
218 writel(cmd->arg & 0xffff, host->base + MMC_ARGL);
219 writel(cmdat, host->base + MMC_CMDAT);
220 writel(host->clkrt, host->base + MMC_CLKRT);
222 writel(START_CLOCK, host->base + MMC_STRPCL);
224 pxamci_enable_irq(host, END_CMD_RES);
227 static void pxamci_finish_request(struct pxamci_host *host, struct mmc_request *mrq)
232 mmc_request_done(host->mmc, mrq);
235 static int pxamci_cmd_done(struct pxamci_host *host, unsigned int stat)
237 struct mmc_command *cmd = host->cmd;
247 * Did I mention this is Sick. We always need to
248 * discard the upper 8 bits of the first 16-bit word.
250 v = readl(host->base + MMC_RES) & 0xffff;
251 for (i = 0; i < 4; i++) {
252 u32 w1 = readl(host->base + MMC_RES) & 0xffff;
253 u32 w2 = readl(host->base + MMC_RES) & 0xffff;
254 cmd->resp[i] = v << 24 | w1 << 8 | w2 >> 8;
258 if (stat & STAT_TIME_OUT_RESPONSE) {
259 cmd->error = -ETIMEDOUT;
260 } else if (stat & STAT_RES_CRC_ERR && cmd->flags & MMC_RSP_CRC) {
262 * workaround for erratum #42:
263 * Intel PXA27x Family Processor Specification Update Rev 001
264 * A bogus CRC error can appear if the msb of a 136 bit
267 if (cpu_is_pxa27x() &&
268 (cmd->flags & MMC_RSP_136 && cmd->resp[0] & 0x80000000))
269 pr_debug("ignoring CRC from command %d - *risky*\n", cmd->opcode);
271 cmd->error = -EILSEQ;
274 pxamci_disable_irq(host, END_CMD_RES);
275 if (host->data && !cmd->error) {
276 pxamci_enable_irq(host, DATA_TRAN_DONE);
278 * workaround for erratum #91, if doing write
281 if (cpu_is_pxa27x() && host->data->flags & MMC_DATA_WRITE)
282 DCSR(host->dma) = DCSR_RUN;
284 pxamci_finish_request(host, host->mrq);
290 static int pxamci_data_done(struct pxamci_host *host, unsigned int stat)
292 struct mmc_data *data = host->data;
298 dma_unmap_sg(mmc_dev(host->mmc), data->sg, data->sg_len,
301 if (stat & STAT_READ_TIME_OUT)
302 data->error = -ETIMEDOUT;
303 else if (stat & (STAT_CRC_READ_ERROR|STAT_CRC_WRITE_ERROR))
304 data->error = -EILSEQ;
307 * There appears to be a hardware design bug here. There seems to
308 * be no way to find out how much data was transferred to the card.
309 * This means that if there was an error on any block, we mark all
310 * data blocks as being in error.
313 data->bytes_xfered = data->blocks * data->blksz;
315 data->bytes_xfered = 0;
317 pxamci_disable_irq(host, DATA_TRAN_DONE);
320 if (host->mrq->stop) {
321 pxamci_stop_clock(host);
322 pxamci_start_cmd(host, host->mrq->stop, host->cmdat);
324 pxamci_finish_request(host, host->mrq);
330 static irqreturn_t pxamci_irq(int irq, void *devid)
332 struct pxamci_host *host = devid;
336 ireg = readl(host->base + MMC_I_REG) & ~readl(host->base + MMC_I_MASK);
339 unsigned stat = readl(host->base + MMC_STAT);
341 pr_debug("PXAMCI: irq %08x stat %08x\n", ireg, stat);
343 if (ireg & END_CMD_RES)
344 handled |= pxamci_cmd_done(host, stat);
345 if (ireg & DATA_TRAN_DONE)
346 handled |= pxamci_data_done(host, stat);
347 if (ireg & SDIO_INT) {
348 mmc_signal_sdio_irq(host->mmc);
353 return IRQ_RETVAL(handled);
356 static void pxamci_request(struct mmc_host *mmc, struct mmc_request *mrq)
358 struct pxamci_host *host = mmc_priv(mmc);
361 WARN_ON(host->mrq != NULL);
365 pxamci_stop_clock(host);
368 host->cmdat &= ~CMDAT_INIT;
371 pxamci_setup_data(host, mrq->data);
373 cmdat &= ~CMDAT_BUSY;
374 cmdat |= CMDAT_DATAEN | CMDAT_DMAEN;
375 if (mrq->data->flags & MMC_DATA_WRITE)
376 cmdat |= CMDAT_WRITE;
378 if (mrq->data->flags & MMC_DATA_STREAM)
379 cmdat |= CMDAT_STREAM;
382 pxamci_start_cmd(host, mrq->cmd, cmdat);
385 static int pxamci_get_ro(struct mmc_host *mmc)
387 struct pxamci_host *host = mmc_priv(mmc);
389 if (host->pdata && host->pdata->get_ro)
390 return !!host->pdata->get_ro(mmc_dev(mmc));
392 * Board doesn't support read only detection; let the mmc core
398 static void pxamci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
400 struct pxamci_host *host = mmc_priv(mmc);
403 unsigned long rate = host->clkrate;
404 unsigned int clk = rate / ios->clock;
406 if (host->clkrt == CLKRT_OFF)
407 clk_enable(host->clk);
409 if (ios->clock == 26000000) {
410 /* to support 26MHz on pxa300/pxa310 */
413 /* to handle (19.5MHz, 26MHz) */
418 * clk might result in a lower divisor than we
419 * desire. check for that condition and adjust
422 if (rate / clk > ios->clock)
424 host->clkrt = fls(clk) - 1;
428 * we write clkrt on the next command
431 pxamci_stop_clock(host);
432 if (host->clkrt != CLKRT_OFF) {
433 host->clkrt = CLKRT_OFF;
434 clk_disable(host->clk);
438 if (host->power_mode != ios->power_mode) {
439 host->power_mode = ios->power_mode;
441 if (host->pdata && host->pdata->setpower)
442 host->pdata->setpower(mmc_dev(mmc), ios->vdd);
444 if (ios->power_mode == MMC_POWER_ON)
445 host->cmdat |= CMDAT_INIT;
448 if (ios->bus_width == MMC_BUS_WIDTH_4)
449 host->cmdat |= CMDAT_SD_4DAT;
451 host->cmdat &= ~CMDAT_SD_4DAT;
453 pr_debug("PXAMCI: clkrt = %x cmdat = %x\n",
454 host->clkrt, host->cmdat);
457 static void pxamci_enable_sdio_irq(struct mmc_host *host, int enable)
459 struct pxamci_host *pxa_host = mmc_priv(host);
462 pxamci_enable_irq(pxa_host, SDIO_INT);
464 pxamci_disable_irq(pxa_host, SDIO_INT);
467 static const struct mmc_host_ops pxamci_ops = {
468 .request = pxamci_request,
469 .get_ro = pxamci_get_ro,
470 .set_ios = pxamci_set_ios,
471 .enable_sdio_irq = pxamci_enable_sdio_irq,
474 static void pxamci_dma_irq(int dma, void *devid)
476 struct pxamci_host *host = devid;
477 int dcsr = DCSR(dma);
478 DCSR(dma) = dcsr & ~DCSR_STOPIRQEN;
480 if (dcsr & DCSR_ENDINTR) {
481 writel(BUF_PART_FULL, host->base + MMC_PRTBUF);
483 printk(KERN_ERR "%s: DMA error on channel %d (DCSR=%#x)\n",
484 mmc_hostname(host->mmc), dma, dcsr);
485 host->data->error = -EIO;
486 pxamci_data_done(host, 0);
490 static irqreturn_t pxamci_detect_irq(int irq, void *devid)
492 struct pxamci_host *host = mmc_priv(devid);
494 mmc_detect_change(devid, host->pdata->detect_delay);
498 static int pxamci_probe(struct platform_device *pdev)
500 struct mmc_host *mmc;
501 struct pxamci_host *host = NULL;
502 struct resource *r, *dmarx, *dmatx;
505 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
506 irq = platform_get_irq(pdev, 0);
510 r = request_mem_region(r->start, SZ_4K, DRIVER_NAME);
514 mmc = mmc_alloc_host(sizeof(struct pxamci_host), &pdev->dev);
520 mmc->ops = &pxamci_ops;
523 * We can do SG-DMA, but we don't because we never know how much
524 * data we successfully wrote to the card.
526 mmc->max_phys_segs = NR_SG;
529 * Our hardware DMA can handle a maximum of one page per SG entry.
531 mmc->max_seg_size = PAGE_SIZE;
534 * Block length register is only 10 bits before PXA27x.
536 mmc->max_blk_size = cpu_is_pxa25x() ? 1023 : 2048;
539 * Block count register is 16 bits.
541 mmc->max_blk_count = 65535;
543 host = mmc_priv(mmc);
546 host->pdata = pdev->dev.platform_data;
547 host->clkrt = CLKRT_OFF;
549 host->clk = clk_get(&pdev->dev, NULL);
550 if (IS_ERR(host->clk)) {
551 ret = PTR_ERR(host->clk);
556 host->clkrate = clk_get_rate(host->clk);
559 * Calculate minimum clock rate, rounding up.
561 mmc->f_min = (host->clkrate + 63) / 64;
562 mmc->f_max = (cpu_is_pxa300() || cpu_is_pxa310()) ? 26000000
565 mmc->ocr_avail = host->pdata ?
566 host->pdata->ocr_mask :
567 MMC_VDD_32_33|MMC_VDD_33_34;
570 if (!cpu_is_pxa25x()) {
571 mmc->caps |= MMC_CAP_4_BIT_DATA | MMC_CAP_SDIO_IRQ;
572 host->cmdat |= CMDAT_SDIO_INT_EN;
573 if (cpu_is_pxa300() || cpu_is_pxa310())
574 mmc->caps |= MMC_CAP_MMC_HIGHSPEED |
575 MMC_CAP_SD_HIGHSPEED;
578 host->sg_cpu = dma_alloc_coherent(&pdev->dev, PAGE_SIZE, &host->sg_dma, GFP_KERNEL);
584 spin_lock_init(&host->lock);
587 host->imask = MMC_I_MASK_ALL;
589 host->base = ioremap(r->start, SZ_4K);
596 * Ensure that the host controller is shut down, and setup
599 pxamci_stop_clock(host);
600 writel(0, host->base + MMC_SPI);
601 writel(64, host->base + MMC_RESTO);
602 writel(host->imask, host->base + MMC_I_MASK);
604 host->dma = pxa_request_dma(DRIVER_NAME, DMA_PRIO_LOW,
605 pxamci_dma_irq, host);
611 ret = request_irq(host->irq, pxamci_irq, 0, DRIVER_NAME, host);
615 platform_set_drvdata(pdev, mmc);
617 dmarx = platform_get_resource(pdev, IORESOURCE_DMA, 0);
622 host->dma_drcmrrx = dmarx->start;
624 dmatx = platform_get_resource(pdev, IORESOURCE_DMA, 1);
629 host->dma_drcmrtx = dmatx->start;
631 if (host->pdata && host->pdata->init)
632 host->pdata->init(&pdev->dev, pxamci_detect_irq, mmc);
641 pxa_free_dma(host->dma);
645 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
655 static int pxamci_remove(struct platform_device *pdev)
657 struct mmc_host *mmc = platform_get_drvdata(pdev);
659 platform_set_drvdata(pdev, NULL);
662 struct pxamci_host *host = mmc_priv(mmc);
664 if (host->pdata && host->pdata->exit)
665 host->pdata->exit(&pdev->dev, mmc);
667 mmc_remove_host(mmc);
669 pxamci_stop_clock(host);
670 writel(TXFIFO_WR_REQ|RXFIFO_RD_REQ|CLK_IS_OFF|STOP_CMD|
671 END_CMD_RES|PRG_DONE|DATA_TRAN_DONE,
672 host->base + MMC_I_MASK);
674 DRCMR(host->dma_drcmrrx) = 0;
675 DRCMR(host->dma_drcmrtx) = 0;
677 free_irq(host->irq, host);
678 pxa_free_dma(host->dma);
680 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
684 release_resource(host->res);
692 static int pxamci_suspend(struct platform_device *dev, pm_message_t state)
694 struct mmc_host *mmc = platform_get_drvdata(dev);
698 ret = mmc_suspend_host(mmc, state);
703 static int pxamci_resume(struct platform_device *dev)
705 struct mmc_host *mmc = platform_get_drvdata(dev);
709 ret = mmc_resume_host(mmc);
714 #define pxamci_suspend NULL
715 #define pxamci_resume NULL
718 static struct platform_driver pxamci_driver = {
719 .probe = pxamci_probe,
720 .remove = pxamci_remove,
721 .suspend = pxamci_suspend,
722 .resume = pxamci_resume,
725 .owner = THIS_MODULE,
729 static int __init pxamci_init(void)
731 return platform_driver_register(&pxamci_driver);
734 static void __exit pxamci_exit(void)
736 platform_driver_unregister(&pxamci_driver);
739 module_init(pxamci_init);
740 module_exit(pxamci_exit);
742 MODULE_DESCRIPTION("PXA Multimedia Card Interface Driver");
743 MODULE_LICENSE("GPL");
744 MODULE_ALIAS("platform:pxa2xx-mci");