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>
32 #include <asm/sizes.h>
34 #include <asm/arch/pxa-regs.h>
35 #include <asm/arch/mmc.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;
122 if (data->flags & MMC_DATA_STREAM)
125 writel(nob, host->base + MMC_NOB);
126 writel(data->blksz, host->base + MMC_BLKLEN);
128 clks = (unsigned long long)data->timeout_ns * host->clkrate;
129 do_div(clks, 1000000000UL);
130 timeout = (unsigned int)clks + (data->timeout_clks << host->clkrt);
131 writel((timeout + 255) / 256, host->base + MMC_RDTO);
133 if (data->flags & MMC_DATA_READ) {
134 host->dma_dir = DMA_FROM_DEVICE;
135 dcmd = DCMD_INCTRGADDR | DCMD_FLOWTRG;
136 DRCMR(host->dma_drcmrtx) = 0;
137 DRCMR(host->dma_drcmrrx) = host->dma | DRCMR_MAPVLD;
139 host->dma_dir = DMA_TO_DEVICE;
140 dcmd = DCMD_INCSRCADDR | DCMD_FLOWSRC;
141 DRCMR(host->dma_drcmrrx) = 0;
142 DRCMR(host->dma_drcmrtx) = host->dma | DRCMR_MAPVLD;
145 dcmd |= DCMD_BURST32 | DCMD_WIDTH1;
147 host->dma_len = dma_map_sg(mmc_dev(host->mmc), data->sg, data->sg_len,
150 for (i = 0; i < host->dma_len; i++) {
151 unsigned int length = sg_dma_len(&data->sg[i]);
152 host->sg_cpu[i].dcmd = dcmd | length;
153 if (length & 31 && !(data->flags & MMC_DATA_READ))
154 host->sg_cpu[i].dcmd |= DCMD_ENDIRQEN;
155 if (data->flags & MMC_DATA_READ) {
156 host->sg_cpu[i].dsadr = host->res->start + MMC_RXFIFO;
157 host->sg_cpu[i].dtadr = sg_dma_address(&data->sg[i]);
159 host->sg_cpu[i].dsadr = sg_dma_address(&data->sg[i]);
160 host->sg_cpu[i].dtadr = host->res->start + MMC_TXFIFO;
162 host->sg_cpu[i].ddadr = host->sg_dma + (i + 1) *
163 sizeof(struct pxa_dma_desc);
165 host->sg_cpu[host->dma_len - 1].ddadr = DDADR_STOP;
168 DDADR(host->dma) = host->sg_dma;
169 DCSR(host->dma) = DCSR_RUN;
172 static void pxamci_start_cmd(struct pxamci_host *host, struct mmc_command *cmd, unsigned int cmdat)
174 WARN_ON(host->cmd != NULL);
177 if (cmd->flags & MMC_RSP_BUSY)
180 #define RSP_TYPE(x) ((x) & ~(MMC_RSP_BUSY|MMC_RSP_OPCODE))
181 switch (RSP_TYPE(mmc_resp_type(cmd))) {
182 case RSP_TYPE(MMC_RSP_R1): /* r1, r1b, r6, r7 */
183 cmdat |= CMDAT_RESP_SHORT;
185 case RSP_TYPE(MMC_RSP_R3):
186 cmdat |= CMDAT_RESP_R3;
188 case RSP_TYPE(MMC_RSP_R2):
189 cmdat |= CMDAT_RESP_R2;
195 writel(cmd->opcode, host->base + MMC_CMD);
196 writel(cmd->arg >> 16, host->base + MMC_ARGH);
197 writel(cmd->arg & 0xffff, host->base + MMC_ARGL);
198 writel(cmdat, host->base + MMC_CMDAT);
199 writel(host->clkrt, host->base + MMC_CLKRT);
201 writel(START_CLOCK, host->base + MMC_STRPCL);
203 pxamci_enable_irq(host, END_CMD_RES);
206 static void pxamci_finish_request(struct pxamci_host *host, struct mmc_request *mrq)
211 mmc_request_done(host->mmc, mrq);
214 static int pxamci_cmd_done(struct pxamci_host *host, unsigned int stat)
216 struct mmc_command *cmd = host->cmd;
226 * Did I mention this is Sick. We always need to
227 * discard the upper 8 bits of the first 16-bit word.
229 v = readl(host->base + MMC_RES) & 0xffff;
230 for (i = 0; i < 4; i++) {
231 u32 w1 = readl(host->base + MMC_RES) & 0xffff;
232 u32 w2 = readl(host->base + MMC_RES) & 0xffff;
233 cmd->resp[i] = v << 24 | w1 << 8 | w2 >> 8;
237 if (stat & STAT_TIME_OUT_RESPONSE) {
238 cmd->error = -ETIMEDOUT;
239 } else if (stat & STAT_RES_CRC_ERR && cmd->flags & MMC_RSP_CRC) {
242 * workaround for erratum #42:
243 * Intel PXA27x Family Processor Specification Update Rev 001
244 * A bogus CRC error can appear if the msb of a 136 bit
247 if (cmd->flags & MMC_RSP_136 && cmd->resp[0] & 0x80000000) {
248 pr_debug("ignoring CRC from command %d - *risky*\n", cmd->opcode);
251 cmd->error = -EILSEQ;
254 pxamci_disable_irq(host, END_CMD_RES);
255 if (host->data && !cmd->error) {
256 pxamci_enable_irq(host, DATA_TRAN_DONE);
258 pxamci_finish_request(host, host->mrq);
264 static int pxamci_data_done(struct pxamci_host *host, unsigned int stat)
266 struct mmc_data *data = host->data;
272 dma_unmap_sg(mmc_dev(host->mmc), data->sg, host->dma_len,
275 if (stat & STAT_READ_TIME_OUT)
276 data->error = -ETIMEDOUT;
277 else if (stat & (STAT_CRC_READ_ERROR|STAT_CRC_WRITE_ERROR))
278 data->error = -EILSEQ;
281 * There appears to be a hardware design bug here. There seems to
282 * be no way to find out how much data was transferred to the card.
283 * This means that if there was an error on any block, we mark all
284 * data blocks as being in error.
287 data->bytes_xfered = data->blocks * data->blksz;
289 data->bytes_xfered = 0;
291 pxamci_disable_irq(host, DATA_TRAN_DONE);
294 if (host->mrq->stop) {
295 pxamci_stop_clock(host);
296 pxamci_start_cmd(host, host->mrq->stop, host->cmdat);
298 pxamci_finish_request(host, host->mrq);
304 static irqreturn_t pxamci_irq(int irq, void *devid)
306 struct pxamci_host *host = devid;
310 ireg = readl(host->base + MMC_I_REG) & ~readl(host->base + MMC_I_MASK);
313 unsigned stat = readl(host->base + MMC_STAT);
315 pr_debug("PXAMCI: irq %08x stat %08x\n", ireg, stat);
317 if (ireg & END_CMD_RES)
318 handled |= pxamci_cmd_done(host, stat);
319 if (ireg & DATA_TRAN_DONE)
320 handled |= pxamci_data_done(host, stat);
321 if (ireg & SDIO_INT) {
322 mmc_signal_sdio_irq(host->mmc);
327 return IRQ_RETVAL(handled);
330 static void pxamci_request(struct mmc_host *mmc, struct mmc_request *mrq)
332 struct pxamci_host *host = mmc_priv(mmc);
335 WARN_ON(host->mrq != NULL);
339 pxamci_stop_clock(host);
342 host->cmdat &= ~CMDAT_INIT;
345 pxamci_setup_data(host, mrq->data);
347 cmdat &= ~CMDAT_BUSY;
348 cmdat |= CMDAT_DATAEN | CMDAT_DMAEN;
349 if (mrq->data->flags & MMC_DATA_WRITE)
350 cmdat |= CMDAT_WRITE;
352 if (mrq->data->flags & MMC_DATA_STREAM)
353 cmdat |= CMDAT_STREAM;
356 pxamci_start_cmd(host, mrq->cmd, cmdat);
359 static int pxamci_get_ro(struct mmc_host *mmc)
361 struct pxamci_host *host = mmc_priv(mmc);
363 if (host->pdata && host->pdata->get_ro)
364 return host->pdata->get_ro(mmc_dev(mmc));
365 /* Host doesn't support read only detection so assume writeable */
369 static void pxamci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
371 struct pxamci_host *host = mmc_priv(mmc);
374 unsigned long rate = host->clkrate;
375 unsigned int clk = rate / ios->clock;
377 if (host->clkrt == CLKRT_OFF)
378 clk_enable(host->clk);
380 if (ios->clock == 26000000) {
381 /* to support 26MHz on pxa300/pxa310 */
384 /* to handle (19.5MHz, 26MHz) */
389 * clk might result in a lower divisor than we
390 * desire. check for that condition and adjust
393 if (rate / clk > ios->clock)
395 host->clkrt = fls(clk) - 1;
399 * we write clkrt on the next command
402 pxamci_stop_clock(host);
403 if (host->clkrt != CLKRT_OFF) {
404 host->clkrt = CLKRT_OFF;
405 clk_disable(host->clk);
409 if (host->power_mode != ios->power_mode) {
410 host->power_mode = ios->power_mode;
412 if (host->pdata && host->pdata->setpower)
413 host->pdata->setpower(mmc_dev(mmc), ios->vdd);
415 if (ios->power_mode == MMC_POWER_ON)
416 host->cmdat |= CMDAT_INIT;
419 if (ios->bus_width == MMC_BUS_WIDTH_4)
420 host->cmdat |= CMDAT_SD_4DAT;
422 host->cmdat &= ~CMDAT_SD_4DAT;
424 pr_debug("PXAMCI: clkrt = %x cmdat = %x\n",
425 host->clkrt, host->cmdat);
428 static void pxamci_enable_sdio_irq(struct mmc_host *host, int enable)
430 struct pxamci_host *pxa_host = mmc_priv(host);
433 pxamci_enable_irq(pxa_host, SDIO_INT);
435 pxamci_disable_irq(pxa_host, SDIO_INT);
438 static const struct mmc_host_ops pxamci_ops = {
439 .request = pxamci_request,
440 .get_ro = pxamci_get_ro,
441 .set_ios = pxamci_set_ios,
442 .enable_sdio_irq = pxamci_enable_sdio_irq,
445 static void pxamci_dma_irq(int dma, void *devid)
447 struct pxamci_host *host = devid;
448 int dcsr = DCSR(dma);
449 DCSR(dma) = dcsr & ~DCSR_STOPIRQEN;
451 if (dcsr & DCSR_ENDINTR) {
452 writel(BUF_PART_FULL, host->base + MMC_PRTBUF);
454 printk(KERN_ERR "%s: DMA error on channel %d (DCSR=%#x)\n",
455 mmc_hostname(host->mmc), dma, dcsr);
456 host->data->error = -EIO;
457 pxamci_data_done(host, 0);
461 static irqreturn_t pxamci_detect_irq(int irq, void *devid)
463 struct pxamci_host *host = mmc_priv(devid);
465 mmc_detect_change(devid, host->pdata->detect_delay);
469 static int pxamci_probe(struct platform_device *pdev)
471 struct mmc_host *mmc;
472 struct pxamci_host *host = NULL;
473 struct resource *r, *dmarx, *dmatx;
476 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
477 irq = platform_get_irq(pdev, 0);
481 r = request_mem_region(r->start, SZ_4K, DRIVER_NAME);
485 mmc = mmc_alloc_host(sizeof(struct pxamci_host), &pdev->dev);
491 mmc->ops = &pxamci_ops;
494 * We can do SG-DMA, but we don't because we never know how much
495 * data we successfully wrote to the card.
497 mmc->max_phys_segs = NR_SG;
500 * Our hardware DMA can handle a maximum of one page per SG entry.
502 mmc->max_seg_size = PAGE_SIZE;
505 * Block length register is only 10 bits before PXA27x.
507 mmc->max_blk_size = (cpu_is_pxa21x() || cpu_is_pxa25x()) ? 1023 : 2048;
510 * Block count register is 16 bits.
512 mmc->max_blk_count = 65535;
514 host = mmc_priv(mmc);
517 host->pdata = pdev->dev.platform_data;
518 host->clkrt = CLKRT_OFF;
520 host->clk = clk_get(&pdev->dev, "MMCCLK");
521 if (IS_ERR(host->clk)) {
522 ret = PTR_ERR(host->clk);
527 host->clkrate = clk_get_rate(host->clk);
530 * Calculate minimum clock rate, rounding up.
532 mmc->f_min = (host->clkrate + 63) / 64;
533 mmc->f_max = (cpu_is_pxa300() || cpu_is_pxa310()) ? 26000000
536 mmc->ocr_avail = host->pdata ?
537 host->pdata->ocr_mask :
538 MMC_VDD_32_33|MMC_VDD_33_34;
541 if (!cpu_is_pxa21x() && !cpu_is_pxa25x()) {
542 mmc->caps |= MMC_CAP_4_BIT_DATA | MMC_CAP_SDIO_IRQ;
543 host->cmdat |= CMDAT_SDIO_INT_EN;
544 if (cpu_is_pxa300() || cpu_is_pxa310())
545 mmc->caps |= MMC_CAP_MMC_HIGHSPEED |
546 MMC_CAP_SD_HIGHSPEED;
549 host->sg_cpu = dma_alloc_coherent(&pdev->dev, PAGE_SIZE, &host->sg_dma, GFP_KERNEL);
555 spin_lock_init(&host->lock);
558 host->imask = MMC_I_MASK_ALL;
560 host->base = ioremap(r->start, SZ_4K);
567 * Ensure that the host controller is shut down, and setup
570 pxamci_stop_clock(host);
571 writel(0, host->base + MMC_SPI);
572 writel(64, host->base + MMC_RESTO);
573 writel(host->imask, host->base + MMC_I_MASK);
575 host->dma = pxa_request_dma(DRIVER_NAME, DMA_PRIO_LOW,
576 pxamci_dma_irq, host);
582 ret = request_irq(host->irq, pxamci_irq, 0, DRIVER_NAME, host);
586 platform_set_drvdata(pdev, mmc);
588 dmarx = platform_get_resource(pdev, IORESOURCE_DMA, 0);
593 host->dma_drcmrrx = dmarx->start;
595 dmatx = platform_get_resource(pdev, IORESOURCE_DMA, 1);
600 host->dma_drcmrtx = dmatx->start;
602 if (host->pdata && host->pdata->init)
603 host->pdata->init(&pdev->dev, pxamci_detect_irq, mmc);
612 pxa_free_dma(host->dma);
616 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
626 static int pxamci_remove(struct platform_device *pdev)
628 struct mmc_host *mmc = platform_get_drvdata(pdev);
630 platform_set_drvdata(pdev, NULL);
633 struct pxamci_host *host = mmc_priv(mmc);
635 if (host->pdata && host->pdata->exit)
636 host->pdata->exit(&pdev->dev, mmc);
638 mmc_remove_host(mmc);
640 pxamci_stop_clock(host);
641 writel(TXFIFO_WR_REQ|RXFIFO_RD_REQ|CLK_IS_OFF|STOP_CMD|
642 END_CMD_RES|PRG_DONE|DATA_TRAN_DONE,
643 host->base + MMC_I_MASK);
645 DRCMR(host->dma_drcmrrx) = 0;
646 DRCMR(host->dma_drcmrtx) = 0;
648 free_irq(host->irq, host);
649 pxa_free_dma(host->dma);
651 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
655 release_resource(host->res);
663 static int pxamci_suspend(struct platform_device *dev, pm_message_t state)
665 struct mmc_host *mmc = platform_get_drvdata(dev);
669 ret = mmc_suspend_host(mmc, state);
674 static int pxamci_resume(struct platform_device *dev)
676 struct mmc_host *mmc = platform_get_drvdata(dev);
680 ret = mmc_resume_host(mmc);
685 #define pxamci_suspend NULL
686 #define pxamci_resume NULL
689 static struct platform_driver pxamci_driver = {
690 .probe = pxamci_probe,
691 .remove = pxamci_remove,
692 .suspend = pxamci_suspend,
693 .resume = pxamci_resume,
696 .owner = THIS_MODULE,
700 static int __init pxamci_init(void)
702 return platform_driver_register(&pxamci_driver);
705 static void __exit pxamci_exit(void)
707 platform_driver_unregister(&pxamci_driver);
710 module_init(pxamci_init);
711 module_exit(pxamci_exit);
713 MODULE_DESCRIPTION("PXA Multimedia Card Interface Driver");
714 MODULE_LICENSE("GPL");
715 MODULE_ALIAS("platform:pxa2xx-mci");