2 * linux/drivers/mmc/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/config.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/ioport.h>
23 #include <linux/platform_device.h>
24 #include <linux/delay.h>
25 #include <linux/interrupt.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/mmc/host.h>
28 #include <linux/mmc/protocol.h>
32 #include <asm/scatterlist.h>
33 #include <asm/sizes.h>
35 #include <asm/arch/pxa-regs.h>
36 #include <asm/arch/mmc.h>
40 #ifdef CONFIG_MMC_DEBUG
41 #define DBG(x...) printk(KERN_DEBUG x)
43 #define DBG(x...) do { } while (0)
46 #define DRIVER_NAME "pxa2xx-mci"
60 unsigned int power_mode;
61 struct pxamci_platform_data *pdata;
63 struct mmc_request *mrq;
64 struct mmc_command *cmd;
65 struct mmc_data *data;
68 struct pxa_dma_desc *sg_cpu;
74 static inline unsigned int ns_to_clocks(unsigned int ns)
76 return (ns * (CLOCKRATE / 1000000) + 999) / 1000;
79 static void pxamci_stop_clock(struct pxamci_host *host)
81 if (readl(host->base + MMC_STAT) & STAT_CLK_EN) {
82 unsigned long timeout = 10000;
85 writel(STOP_CLOCK, host->base + MMC_STRPCL);
88 v = readl(host->base + MMC_STAT);
89 if (!(v & STAT_CLK_EN))
95 dev_err(mmc_dev(host->mmc), "unable to stop clock\n");
99 static void pxamci_enable_irq(struct pxamci_host *host, unsigned int mask)
103 spin_lock_irqsave(&host->lock, flags);
104 host->imask &= ~mask;
105 writel(host->imask, host->base + MMC_I_MASK);
106 spin_unlock_irqrestore(&host->lock, flags);
109 static void pxamci_disable_irq(struct pxamci_host *host, unsigned int mask)
113 spin_lock_irqsave(&host->lock, flags);
115 writel(host->imask, host->base + MMC_I_MASK);
116 spin_unlock_irqrestore(&host->lock, flags);
119 static void pxamci_setup_data(struct pxamci_host *host, struct mmc_data *data)
121 unsigned int nob = data->blocks;
122 unsigned int timeout;
128 if (data->flags & MMC_DATA_STREAM)
131 writel(nob, host->base + MMC_NOB);
132 writel(1 << data->blksz_bits, host->base + MMC_BLKLEN);
134 timeout = ns_to_clocks(data->timeout_ns) + data->timeout_clks;
135 writel((timeout + 255) / 256, host->base + MMC_RDTO);
137 if (data->flags & MMC_DATA_READ) {
138 host->dma_dir = DMA_FROM_DEVICE;
139 dcmd = DCMD_INCTRGADDR | DCMD_FLOWTRG;
141 DRCMRRXMMC = host->dma | DRCMR_MAPVLD;
143 host->dma_dir = DMA_TO_DEVICE;
144 dcmd = DCMD_INCSRCADDR | DCMD_FLOWSRC;
146 DRCMRTXMMC = host->dma | DRCMR_MAPVLD;
149 dcmd |= DCMD_BURST32 | DCMD_WIDTH1;
151 host->dma_len = dma_map_sg(mmc_dev(host->mmc), data->sg, data->sg_len,
154 for (i = 0; i < host->dma_len; i++) {
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].dcmd = dcmd | sg_dma_len(&data->sg[i]);
163 host->sg_cpu[i].ddadr = host->sg_dma + (i + 1) *
164 sizeof(struct pxa_dma_desc);
166 host->sg_cpu[host->dma_len - 1].ddadr = DDADR_STOP;
169 DDADR(host->dma) = host->sg_dma;
170 DCSR(host->dma) = DCSR_RUN;
173 static void pxamci_start_cmd(struct pxamci_host *host, struct mmc_command *cmd, unsigned int cmdat)
175 WARN_ON(host->cmd != NULL);
178 if (cmd->flags & MMC_RSP_BUSY)
181 switch (cmd->flags & (MMC_RSP_MASK | MMC_RSP_CRC)) {
182 case MMC_RSP_SHORT | MMC_RSP_CRC:
183 cmdat |= CMDAT_RESP_SHORT;
186 cmdat |= CMDAT_RESP_R3;
188 case MMC_RSP_LONG | MMC_RSP_CRC:
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)
208 DBG("PXAMCI: request done\n");
212 mmc_request_done(host->mmc, mrq);
215 static int pxamci_cmd_done(struct pxamci_host *host, unsigned int stat)
217 struct mmc_command *cmd = host->cmd;
227 * Did I mention this is Sick. We always need to
228 * discard the upper 8 bits of the first 16-bit word.
230 v = readl(host->base + MMC_RES) & 0xffff;
231 for (i = 0; i < 4; i++) {
232 u32 w1 = readl(host->base + MMC_RES) & 0xffff;
233 u32 w2 = readl(host->base + MMC_RES) & 0xffff;
234 cmd->resp[i] = v << 24 | w1 << 8 | w2 >> 8;
238 if (stat & STAT_TIME_OUT_RESPONSE) {
239 cmd->error = MMC_ERR_TIMEOUT;
240 } else if (stat & STAT_RES_CRC_ERR && cmd->flags & MMC_RSP_CRC) {
243 * workaround for erratum #42:
244 * Intel PXA27x Family Processor Specification Update Rev 001
246 if (cmd->opcode == MMC_ALL_SEND_CID ||
247 cmd->opcode == MMC_SEND_CSD ||
248 cmd->opcode == MMC_SEND_CID) {
249 /* a bogus CRC error can appear if the msb of
250 the 15 byte response is a one */
251 if ((cmd->resp[0] & 0x80000000) == 0)
252 cmd->error = MMC_ERR_BADCRC;
254 DBG("ignoring CRC from command %d - *risky*\n",cmd->opcode);
257 cmd->error = MMC_ERR_BADCRC;
261 pxamci_disable_irq(host, END_CMD_RES);
262 if (host->data && cmd->error == MMC_ERR_NONE) {
263 pxamci_enable_irq(host, DATA_TRAN_DONE);
265 pxamci_finish_request(host, host->mrq);
271 static int pxamci_data_done(struct pxamci_host *host, unsigned int stat)
273 struct mmc_data *data = host->data;
279 dma_unmap_sg(mmc_dev(host->mmc), data->sg, host->dma_len,
282 if (stat & STAT_READ_TIME_OUT)
283 data->error = MMC_ERR_TIMEOUT;
284 else if (stat & (STAT_CRC_READ_ERROR|STAT_CRC_WRITE_ERROR))
285 data->error = MMC_ERR_BADCRC;
288 * There appears to be a hardware design bug here. There seems to
289 * be no way to find out how much data was transferred to the card.
290 * This means that if there was an error on any block, we mark all
291 * data blocks as being in error.
293 if (data->error == MMC_ERR_NONE)
294 data->bytes_xfered = data->blocks << data->blksz_bits;
296 data->bytes_xfered = 0;
298 pxamci_disable_irq(host, DATA_TRAN_DONE);
301 if (host->mrq->stop && data->error == MMC_ERR_NONE) {
302 pxamci_stop_clock(host);
303 pxamci_start_cmd(host, host->mrq->stop, 0);
305 pxamci_finish_request(host, host->mrq);
311 static irqreturn_t pxamci_irq(int irq, void *devid, struct pt_regs *regs)
313 struct pxamci_host *host = devid;
317 ireg = readl(host->base + MMC_I_REG);
319 DBG("PXAMCI: irq %08x\n", ireg);
322 unsigned stat = readl(host->base + MMC_STAT);
324 DBG("PXAMCI: stat %08x\n", stat);
326 if (ireg & END_CMD_RES)
327 handled |= pxamci_cmd_done(host, stat);
328 if (ireg & DATA_TRAN_DONE)
329 handled |= pxamci_data_done(host, stat);
332 return IRQ_RETVAL(handled);
335 static void pxamci_request(struct mmc_host *mmc, struct mmc_request *mrq)
337 struct pxamci_host *host = mmc_priv(mmc);
340 WARN_ON(host->mrq != NULL);
344 pxamci_stop_clock(host);
347 host->cmdat &= ~CMDAT_INIT;
350 pxamci_setup_data(host, mrq->data);
352 cmdat &= ~CMDAT_BUSY;
353 cmdat |= CMDAT_DATAEN | CMDAT_DMAEN;
354 if (mrq->data->flags & MMC_DATA_WRITE)
355 cmdat |= CMDAT_WRITE;
357 if (mrq->data->flags & MMC_DATA_STREAM)
358 cmdat |= CMDAT_STREAM;
361 pxamci_start_cmd(host, mrq->cmd, cmdat);
364 static int pxamci_get_ro(struct mmc_host *mmc)
366 struct pxamci_host *host = mmc_priv(mmc);
368 if (host->pdata && host->pdata->get_ro)
369 return host->pdata->get_ro(mmc->dev);
370 /* Host doesn't support read only detection so assume writeable */
374 static void pxamci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
376 struct pxamci_host *host = mmc_priv(mmc);
378 DBG("pxamci_set_ios: clock %u power %u vdd %u.%02u\n",
379 ios->clock, ios->power_mode, ios->vdd / 100,
383 unsigned int clk = CLOCKRATE / ios->clock;
384 if (CLOCKRATE / clk > ios->clock)
386 host->clkrt = fls(clk) - 1;
387 pxa_set_cken(CKEN12_MMC, 1);
390 * we write clkrt on the next command
393 pxamci_stop_clock(host);
394 pxa_set_cken(CKEN12_MMC, 0);
397 if (host->power_mode != ios->power_mode) {
398 host->power_mode = ios->power_mode;
400 if (host->pdata && host->pdata->setpower)
401 host->pdata->setpower(mmc->dev, ios->vdd);
403 if (ios->power_mode == MMC_POWER_ON)
404 host->cmdat |= CMDAT_INIT;
407 DBG("pxamci_set_ios: clkrt = %x cmdat = %x\n",
408 host->clkrt, host->cmdat);
411 static struct mmc_host_ops pxamci_ops = {
412 .request = pxamci_request,
413 .get_ro = pxamci_get_ro,
414 .set_ios = pxamci_set_ios,
417 static void pxamci_dma_irq(int dma, void *devid, struct pt_regs *regs)
419 printk(KERN_ERR "DMA%d: IRQ???\n", dma);
420 DCSR(dma) = DCSR_STARTINTR|DCSR_ENDINTR|DCSR_BUSERR;
423 static irqreturn_t pxamci_detect_irq(int irq, void *devid, struct pt_regs *regs)
425 struct pxamci_host *host = mmc_priv(devid);
427 mmc_detect_change(devid, host->pdata->detect_delay);
431 static int pxamci_probe(struct platform_device *pdev)
433 struct mmc_host *mmc;
434 struct pxamci_host *host = NULL;
438 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
439 irq = platform_get_irq(pdev, 0);
440 if (!r || irq == NO_IRQ)
443 r = request_mem_region(r->start, SZ_4K, DRIVER_NAME);
447 mmc = mmc_alloc_host(sizeof(struct pxamci_host), &pdev->dev);
453 mmc->ops = &pxamci_ops;
454 mmc->f_min = CLOCKRATE_MIN;
455 mmc->f_max = CLOCKRATE_MAX;
458 * We can do SG-DMA, but we don't because we never know how much
459 * data we successfully wrote to the card.
461 mmc->max_phys_segs = NR_SG;
464 * Our hardware DMA can handle a maximum of one page per SG entry.
466 mmc->max_seg_size = PAGE_SIZE;
468 host = mmc_priv(mmc);
471 host->pdata = pdev->dev.platform_data;
472 mmc->ocr_avail = host->pdata ?
473 host->pdata->ocr_mask :
474 MMC_VDD_32_33|MMC_VDD_33_34;
476 host->sg_cpu = dma_alloc_coherent(&pdev->dev, PAGE_SIZE, &host->sg_dma, GFP_KERNEL);
482 spin_lock_init(&host->lock);
485 host->imask = MMC_I_MASK_ALL;
487 host->base = ioremap(r->start, SZ_4K);
494 * Ensure that the host controller is shut down, and setup
497 pxamci_stop_clock(host);
498 writel(0, host->base + MMC_SPI);
499 writel(64, host->base + MMC_RESTO);
500 writel(host->imask, host->base + MMC_I_MASK);
502 host->dma = pxa_request_dma(DRIVER_NAME, DMA_PRIO_LOW,
503 pxamci_dma_irq, host);
509 ret = request_irq(host->irq, pxamci_irq, 0, DRIVER_NAME, host);
513 platform_set_drvdata(pdev, mmc);
515 if (host->pdata && host->pdata->init)
516 host->pdata->init(&pdev->dev, pxamci_detect_irq, mmc);
525 pxa_free_dma(host->dma);
529 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
537 static int pxamci_remove(struct platform_device *pdev)
539 struct mmc_host *mmc = platform_get_drvdata(pdev);
541 platform_set_drvdata(pdev, NULL);
544 struct pxamci_host *host = mmc_priv(mmc);
546 if (host->pdata && host->pdata->exit)
547 host->pdata->exit(&pdev->dev, mmc);
549 mmc_remove_host(mmc);
551 pxamci_stop_clock(host);
552 writel(TXFIFO_WR_REQ|RXFIFO_RD_REQ|CLK_IS_OFF|STOP_CMD|
553 END_CMD_RES|PRG_DONE|DATA_TRAN_DONE,
554 host->base + MMC_I_MASK);
559 free_irq(host->irq, host);
560 pxa_free_dma(host->dma);
562 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
564 release_resource(host->res);
572 static int pxamci_suspend(struct platform_device *dev, pm_message_t state)
574 struct mmc_host *mmc = platform_get_drvdata(dev);
578 ret = mmc_suspend_host(mmc, state);
583 static int pxamci_resume(struct platform_device *dev)
585 struct mmc_host *mmc = platform_get_drvdata(dev);
589 ret = mmc_resume_host(mmc);
594 #define pxamci_suspend NULL
595 #define pxamci_resume NULL
598 static struct platform_driver pxamci_driver = {
599 .probe = pxamci_probe,
600 .remove = pxamci_remove,
601 .suspend = pxamci_suspend,
602 .resume = pxamci_resume,
608 static int __init pxamci_init(void)
610 return platform_driver_register(&pxamci_driver);
613 static void __exit pxamci_exit(void)
615 platform_driver_unregister(&pxamci_driver);
618 module_init(pxamci_init);
619 module_exit(pxamci_exit);
621 MODULE_DESCRIPTION("PXA Multimedia Card Interface Driver");
622 MODULE_LICENSE("GPL");