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>
34 #include <mach/hardware.h>
35 #include <mach/pxa-regs.h>
40 #define DRIVER_NAME "pxa2xx-mci"
43 #define CLKRT_OFF (~0)
51 unsigned long clkrate;
57 unsigned int power_mode;
58 struct pxamci_platform_data *pdata;
60 struct mmc_request *mrq;
61 struct mmc_command *cmd;
62 struct mmc_data *data;
65 struct pxa_dma_desc *sg_cpu;
69 unsigned int dma_drcmrrx;
70 unsigned int dma_drcmrtx;
73 static void pxamci_stop_clock(struct pxamci_host *host)
75 if (readl(host->base + MMC_STAT) & STAT_CLK_EN) {
76 unsigned long timeout = 10000;
79 writel(STOP_CLOCK, host->base + MMC_STRPCL);
82 v = readl(host->base + MMC_STAT);
83 if (!(v & STAT_CLK_EN))
89 dev_err(mmc_dev(host->mmc), "unable to stop clock\n");
93 static void pxamci_enable_irq(struct pxamci_host *host, unsigned int mask)
97 spin_lock_irqsave(&host->lock, flags);
99 writel(host->imask, host->base + MMC_I_MASK);
100 spin_unlock_irqrestore(&host->lock, flags);
103 static void pxamci_disable_irq(struct pxamci_host *host, unsigned int mask)
107 spin_lock_irqsave(&host->lock, flags);
109 writel(host->imask, host->base + MMC_I_MASK);
110 spin_unlock_irqrestore(&host->lock, flags);
113 static void pxamci_setup_data(struct pxamci_host *host, struct mmc_data *data)
115 unsigned int nob = data->blocks;
116 unsigned long long clks;
117 unsigned int timeout;
124 if (data->flags & MMC_DATA_STREAM)
127 writel(nob, host->base + MMC_NOB);
128 writel(data->blksz, host->base + MMC_BLKLEN);
130 clks = (unsigned long long)data->timeout_ns * host->clkrate;
131 do_div(clks, 1000000000UL);
132 timeout = (unsigned int)clks + (data->timeout_clks << host->clkrt);
133 writel((timeout + 255) / 256, host->base + MMC_RDTO);
135 if (data->flags & MMC_DATA_READ) {
136 host->dma_dir = DMA_FROM_DEVICE;
137 dcmd = DCMD_INCTRGADDR | DCMD_FLOWTRG;
138 DRCMR(host->dma_drcmrtx) = 0;
139 DRCMR(host->dma_drcmrrx) = host->dma | DRCMR_MAPVLD;
141 host->dma_dir = DMA_TO_DEVICE;
142 dcmd = DCMD_INCSRCADDR | DCMD_FLOWSRC;
143 DRCMR(host->dma_drcmrrx) = 0;
144 DRCMR(host->dma_drcmrtx) = host->dma | DRCMR_MAPVLD;
147 dcmd |= DCMD_BURST32 | DCMD_WIDTH1;
149 host->dma_len = dma_map_sg(mmc_dev(host->mmc), data->sg, data->sg_len,
152 for (i = 0; i < host->dma_len; i++) {
153 unsigned int length = sg_dma_len(&data->sg[i]);
154 host->sg_cpu[i].dcmd = dcmd | length;
155 if (length & 31 && !(data->flags & MMC_DATA_READ))
156 host->sg_cpu[i].dcmd |= DCMD_ENDIRQEN;
157 /* Not aligned to 8-byte boundary? */
158 if (sg_dma_address(&data->sg[i]) & 0x7)
160 if (data->flags & MMC_DATA_READ) {
161 host->sg_cpu[i].dsadr = host->res->start + MMC_RXFIFO;
162 host->sg_cpu[i].dtadr = sg_dma_address(&data->sg[i]);
164 host->sg_cpu[i].dsadr = sg_dma_address(&data->sg[i]);
165 host->sg_cpu[i].dtadr = host->res->start + MMC_TXFIFO;
167 host->sg_cpu[i].ddadr = host->sg_dma + (i + 1) *
168 sizeof(struct pxa_dma_desc);
170 host->sg_cpu[host->dma_len - 1].ddadr = DDADR_STOP;
174 * The PXA27x DMA controller encounters overhead when working with
175 * unaligned (to 8-byte boundaries) data, so switch on byte alignment
176 * mode only if we have unaligned data.
179 DALGN |= (1 << host->dma);
181 DALGN &= ~(1 << host->dma);
182 DDADR(host->dma) = host->sg_dma;
183 DCSR(host->dma) = DCSR_RUN;
186 static void pxamci_start_cmd(struct pxamci_host *host, struct mmc_command *cmd, unsigned int cmdat)
188 WARN_ON(host->cmd != NULL);
191 if (cmd->flags & MMC_RSP_BUSY)
194 #define RSP_TYPE(x) ((x) & ~(MMC_RSP_BUSY|MMC_RSP_OPCODE))
195 switch (RSP_TYPE(mmc_resp_type(cmd))) {
196 case RSP_TYPE(MMC_RSP_R1): /* r1, r1b, r6, r7 */
197 cmdat |= CMDAT_RESP_SHORT;
199 case RSP_TYPE(MMC_RSP_R3):
200 cmdat |= CMDAT_RESP_R3;
202 case RSP_TYPE(MMC_RSP_R2):
203 cmdat |= CMDAT_RESP_R2;
209 writel(cmd->opcode, host->base + MMC_CMD);
210 writel(cmd->arg >> 16, host->base + MMC_ARGH);
211 writel(cmd->arg & 0xffff, host->base + MMC_ARGL);
212 writel(cmdat, host->base + MMC_CMDAT);
213 writel(host->clkrt, host->base + MMC_CLKRT);
215 writel(START_CLOCK, host->base + MMC_STRPCL);
217 pxamci_enable_irq(host, END_CMD_RES);
220 static void pxamci_finish_request(struct pxamci_host *host, struct mmc_request *mrq)
225 mmc_request_done(host->mmc, mrq);
228 static int pxamci_cmd_done(struct pxamci_host *host, unsigned int stat)
230 struct mmc_command *cmd = host->cmd;
240 * Did I mention this is Sick. We always need to
241 * discard the upper 8 bits of the first 16-bit word.
243 v = readl(host->base + MMC_RES) & 0xffff;
244 for (i = 0; i < 4; i++) {
245 u32 w1 = readl(host->base + MMC_RES) & 0xffff;
246 u32 w2 = readl(host->base + MMC_RES) & 0xffff;
247 cmd->resp[i] = v << 24 | w1 << 8 | w2 >> 8;
251 if (stat & STAT_TIME_OUT_RESPONSE) {
252 cmd->error = -ETIMEDOUT;
253 } else if (stat & STAT_RES_CRC_ERR && cmd->flags & MMC_RSP_CRC) {
256 * workaround for erratum #42:
257 * Intel PXA27x Family Processor Specification Update Rev 001
258 * A bogus CRC error can appear if the msb of a 136 bit
261 if (cmd->flags & MMC_RSP_136 && cmd->resp[0] & 0x80000000) {
262 pr_debug("ignoring CRC from command %d - *risky*\n", cmd->opcode);
265 cmd->error = -EILSEQ;
268 pxamci_disable_irq(host, END_CMD_RES);
269 if (host->data && !cmd->error) {
270 pxamci_enable_irq(host, DATA_TRAN_DONE);
272 pxamci_finish_request(host, host->mrq);
278 static int pxamci_data_done(struct pxamci_host *host, unsigned int stat)
280 struct mmc_data *data = host->data;
286 dma_unmap_sg(mmc_dev(host->mmc), data->sg, data->sg_len,
289 if (stat & STAT_READ_TIME_OUT)
290 data->error = -ETIMEDOUT;
291 else if (stat & (STAT_CRC_READ_ERROR|STAT_CRC_WRITE_ERROR))
292 data->error = -EILSEQ;
295 * There appears to be a hardware design bug here. There seems to
296 * be no way to find out how much data was transferred to the card.
297 * This means that if there was an error on any block, we mark all
298 * data blocks as being in error.
301 data->bytes_xfered = data->blocks * data->blksz;
303 data->bytes_xfered = 0;
305 pxamci_disable_irq(host, DATA_TRAN_DONE);
308 if (host->mrq->stop) {
309 pxamci_stop_clock(host);
310 pxamci_start_cmd(host, host->mrq->stop, host->cmdat);
312 pxamci_finish_request(host, host->mrq);
318 static irqreturn_t pxamci_irq(int irq, void *devid)
320 struct pxamci_host *host = devid;
324 ireg = readl(host->base + MMC_I_REG) & ~readl(host->base + MMC_I_MASK);
327 unsigned stat = readl(host->base + MMC_STAT);
329 pr_debug("PXAMCI: irq %08x stat %08x\n", ireg, stat);
331 if (ireg & END_CMD_RES)
332 handled |= pxamci_cmd_done(host, stat);
333 if (ireg & DATA_TRAN_DONE)
334 handled |= pxamci_data_done(host, stat);
335 if (ireg & SDIO_INT) {
336 mmc_signal_sdio_irq(host->mmc);
341 return IRQ_RETVAL(handled);
344 static void pxamci_request(struct mmc_host *mmc, struct mmc_request *mrq)
346 struct pxamci_host *host = mmc_priv(mmc);
349 WARN_ON(host->mrq != NULL);
353 pxamci_stop_clock(host);
356 host->cmdat &= ~CMDAT_INIT;
359 pxamci_setup_data(host, mrq->data);
361 cmdat &= ~CMDAT_BUSY;
362 cmdat |= CMDAT_DATAEN | CMDAT_DMAEN;
363 if (mrq->data->flags & MMC_DATA_WRITE)
364 cmdat |= CMDAT_WRITE;
366 if (mrq->data->flags & MMC_DATA_STREAM)
367 cmdat |= CMDAT_STREAM;
370 pxamci_start_cmd(host, mrq->cmd, cmdat);
373 static int pxamci_get_ro(struct mmc_host *mmc)
375 struct pxamci_host *host = mmc_priv(mmc);
377 if (host->pdata && host->pdata->get_ro)
378 return !!host->pdata->get_ro(mmc_dev(mmc));
380 * Board doesn't support read only detection; let the mmc core
386 static void pxamci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
388 struct pxamci_host *host = mmc_priv(mmc);
391 unsigned long rate = host->clkrate;
392 unsigned int clk = rate / ios->clock;
394 if (host->clkrt == CLKRT_OFF)
395 clk_enable(host->clk);
397 if (ios->clock == 26000000) {
398 /* to support 26MHz on pxa300/pxa310 */
401 /* to handle (19.5MHz, 26MHz) */
406 * clk might result in a lower divisor than we
407 * desire. check for that condition and adjust
410 if (rate / clk > ios->clock)
412 host->clkrt = fls(clk) - 1;
416 * we write clkrt on the next command
419 pxamci_stop_clock(host);
420 if (host->clkrt != CLKRT_OFF) {
421 host->clkrt = CLKRT_OFF;
422 clk_disable(host->clk);
426 if (host->power_mode != ios->power_mode) {
427 host->power_mode = ios->power_mode;
429 if (host->pdata && host->pdata->setpower)
430 host->pdata->setpower(mmc_dev(mmc), ios->vdd);
432 if (ios->power_mode == MMC_POWER_ON)
433 host->cmdat |= CMDAT_INIT;
436 if (ios->bus_width == MMC_BUS_WIDTH_4)
437 host->cmdat |= CMDAT_SD_4DAT;
439 host->cmdat &= ~CMDAT_SD_4DAT;
441 pr_debug("PXAMCI: clkrt = %x cmdat = %x\n",
442 host->clkrt, host->cmdat);
445 static void pxamci_enable_sdio_irq(struct mmc_host *host, int enable)
447 struct pxamci_host *pxa_host = mmc_priv(host);
450 pxamci_enable_irq(pxa_host, SDIO_INT);
452 pxamci_disable_irq(pxa_host, SDIO_INT);
455 static const struct mmc_host_ops pxamci_ops = {
456 .request = pxamci_request,
457 .get_ro = pxamci_get_ro,
458 .set_ios = pxamci_set_ios,
459 .enable_sdio_irq = pxamci_enable_sdio_irq,
462 static void pxamci_dma_irq(int dma, void *devid)
464 struct pxamci_host *host = devid;
465 int dcsr = DCSR(dma);
466 DCSR(dma) = dcsr & ~DCSR_STOPIRQEN;
468 if (dcsr & DCSR_ENDINTR) {
469 writel(BUF_PART_FULL, host->base + MMC_PRTBUF);
471 printk(KERN_ERR "%s: DMA error on channel %d (DCSR=%#x)\n",
472 mmc_hostname(host->mmc), dma, dcsr);
473 host->data->error = -EIO;
474 pxamci_data_done(host, 0);
478 static irqreturn_t pxamci_detect_irq(int irq, void *devid)
480 struct pxamci_host *host = mmc_priv(devid);
482 mmc_detect_change(devid, host->pdata->detect_delay);
486 static int pxamci_probe(struct platform_device *pdev)
488 struct mmc_host *mmc;
489 struct pxamci_host *host = NULL;
490 struct resource *r, *dmarx, *dmatx;
493 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
494 irq = platform_get_irq(pdev, 0);
498 r = request_mem_region(r->start, SZ_4K, DRIVER_NAME);
502 mmc = mmc_alloc_host(sizeof(struct pxamci_host), &pdev->dev);
508 mmc->ops = &pxamci_ops;
511 * We can do SG-DMA, but we don't because we never know how much
512 * data we successfully wrote to the card.
514 mmc->max_phys_segs = NR_SG;
517 * Our hardware DMA can handle a maximum of one page per SG entry.
519 mmc->max_seg_size = PAGE_SIZE;
522 * Block length register is only 10 bits before PXA27x.
524 mmc->max_blk_size = cpu_is_pxa25x() ? 1023 : 2048;
527 * Block count register is 16 bits.
529 mmc->max_blk_count = 65535;
531 host = mmc_priv(mmc);
534 host->pdata = pdev->dev.platform_data;
535 host->clkrt = CLKRT_OFF;
537 host->clk = clk_get(&pdev->dev, NULL);
538 if (IS_ERR(host->clk)) {
539 ret = PTR_ERR(host->clk);
544 host->clkrate = clk_get_rate(host->clk);
547 * Calculate minimum clock rate, rounding up.
549 mmc->f_min = (host->clkrate + 63) / 64;
550 mmc->f_max = (cpu_is_pxa300() || cpu_is_pxa310()) ? 26000000
553 mmc->ocr_avail = host->pdata ?
554 host->pdata->ocr_mask :
555 MMC_VDD_32_33|MMC_VDD_33_34;
558 if (!cpu_is_pxa25x()) {
559 mmc->caps |= MMC_CAP_4_BIT_DATA | MMC_CAP_SDIO_IRQ;
560 host->cmdat |= CMDAT_SDIO_INT_EN;
561 if (cpu_is_pxa300() || cpu_is_pxa310())
562 mmc->caps |= MMC_CAP_MMC_HIGHSPEED |
563 MMC_CAP_SD_HIGHSPEED;
566 host->sg_cpu = dma_alloc_coherent(&pdev->dev, PAGE_SIZE, &host->sg_dma, GFP_KERNEL);
572 spin_lock_init(&host->lock);
575 host->imask = MMC_I_MASK_ALL;
577 host->base = ioremap(r->start, SZ_4K);
584 * Ensure that the host controller is shut down, and setup
587 pxamci_stop_clock(host);
588 writel(0, host->base + MMC_SPI);
589 writel(64, host->base + MMC_RESTO);
590 writel(host->imask, host->base + MMC_I_MASK);
592 host->dma = pxa_request_dma(DRIVER_NAME, DMA_PRIO_LOW,
593 pxamci_dma_irq, host);
599 ret = request_irq(host->irq, pxamci_irq, 0, DRIVER_NAME, host);
603 platform_set_drvdata(pdev, mmc);
605 dmarx = platform_get_resource(pdev, IORESOURCE_DMA, 0);
610 host->dma_drcmrrx = dmarx->start;
612 dmatx = platform_get_resource(pdev, IORESOURCE_DMA, 1);
617 host->dma_drcmrtx = dmatx->start;
619 if (host->pdata && host->pdata->init)
620 host->pdata->init(&pdev->dev, pxamci_detect_irq, mmc);
629 pxa_free_dma(host->dma);
633 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
643 static int pxamci_remove(struct platform_device *pdev)
645 struct mmc_host *mmc = platform_get_drvdata(pdev);
647 platform_set_drvdata(pdev, NULL);
650 struct pxamci_host *host = mmc_priv(mmc);
652 if (host->pdata && host->pdata->exit)
653 host->pdata->exit(&pdev->dev, mmc);
655 mmc_remove_host(mmc);
657 pxamci_stop_clock(host);
658 writel(TXFIFO_WR_REQ|RXFIFO_RD_REQ|CLK_IS_OFF|STOP_CMD|
659 END_CMD_RES|PRG_DONE|DATA_TRAN_DONE,
660 host->base + MMC_I_MASK);
662 DRCMR(host->dma_drcmrrx) = 0;
663 DRCMR(host->dma_drcmrtx) = 0;
665 free_irq(host->irq, host);
666 pxa_free_dma(host->dma);
668 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
672 release_resource(host->res);
680 static int pxamci_suspend(struct platform_device *dev, pm_message_t state)
682 struct mmc_host *mmc = platform_get_drvdata(dev);
686 ret = mmc_suspend_host(mmc, state);
691 static int pxamci_resume(struct platform_device *dev)
693 struct mmc_host *mmc = platform_get_drvdata(dev);
697 ret = mmc_resume_host(mmc);
702 #define pxamci_suspend NULL
703 #define pxamci_resume NULL
706 static struct platform_driver pxamci_driver = {
707 .probe = pxamci_probe,
708 .remove = pxamci_remove,
709 .suspend = pxamci_suspend,
710 .resume = pxamci_resume,
713 .owner = THIS_MODULE,
717 static int __init pxamci_init(void)
719 return platform_driver_register(&pxamci_driver);
722 static void __exit pxamci_exit(void)
724 platform_driver_unregister(&pxamci_driver);
727 module_init(pxamci_init);
728 module_exit(pxamci_exit);
730 MODULE_DESCRIPTION("PXA Multimedia Card Interface Driver");
731 MODULE_LICENSE("GPL");
732 MODULE_ALIAS("platform:pxa2xx-mci");