2 * linux/drivers/mmc/host/mxcmmc.c - Freescale i.MX MMCI driver
4 * This is a driver for the SDHC controller found in Freescale MX2/MX3
5 * SoCs. It is basically the same hardware as found on MX1 (imxmmc.c).
6 * Unlike the hardware found on MX1, this hardware just works and does
7 * not need all the quirks found in imxmmc.c, hence the seperate driver.
9 * Copyright (C) 2008 Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>
10 * Copyright (C) 2006 Pavel Pisa, PiKRON <ppisa@pikron.com>
12 * derived from pxamci.c by Russell King
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/ioport.h>
23 #include <linux/platform_device.h>
24 #include <linux/interrupt.h>
25 #include <linux/irq.h>
26 #include <linux/blkdev.h>
27 #include <linux/dma-mapping.h>
28 #include <linux/mmc/host.h>
29 #include <linux/mmc/card.h>
30 #include <linux/delay.h>
31 #include <linux/clk.h>
33 #include <linux/gpio.h>
37 #include <asm/sizes.h>
40 #ifdef CONFIG_ARCH_MX2
41 #include <mach/dma-mx1-mx2.h>
45 #define DRIVER_NAME "mxc-mmc"
47 #define MMC_REG_STR_STP_CLK 0x00
48 #define MMC_REG_STATUS 0x04
49 #define MMC_REG_CLK_RATE 0x08
50 #define MMC_REG_CMD_DAT_CONT 0x0C
51 #define MMC_REG_RES_TO 0x10
52 #define MMC_REG_READ_TO 0x14
53 #define MMC_REG_BLK_LEN 0x18
54 #define MMC_REG_NOB 0x1C
55 #define MMC_REG_REV_NO 0x20
56 #define MMC_REG_INT_CNTR 0x24
57 #define MMC_REG_CMD 0x28
58 #define MMC_REG_ARG 0x2C
59 #define MMC_REG_RES_FIFO 0x34
60 #define MMC_REG_BUFFER_ACCESS 0x38
62 #define STR_STP_CLK_RESET (1 << 3)
63 #define STR_STP_CLK_START_CLK (1 << 1)
64 #define STR_STP_CLK_STOP_CLK (1 << 0)
66 #define STATUS_CARD_INSERTION (1 << 31)
67 #define STATUS_CARD_REMOVAL (1 << 30)
68 #define STATUS_YBUF_EMPTY (1 << 29)
69 #define STATUS_XBUF_EMPTY (1 << 28)
70 #define STATUS_YBUF_FULL (1 << 27)
71 #define STATUS_XBUF_FULL (1 << 26)
72 #define STATUS_BUF_UND_RUN (1 << 25)
73 #define STATUS_BUF_OVFL (1 << 24)
74 #define STATUS_SDIO_INT_ACTIVE (1 << 14)
75 #define STATUS_END_CMD_RESP (1 << 13)
76 #define STATUS_WRITE_OP_DONE (1 << 12)
77 #define STATUS_DATA_TRANS_DONE (1 << 11)
78 #define STATUS_READ_OP_DONE (1 << 11)
79 #define STATUS_WR_CRC_ERROR_CODE_MASK (3 << 10)
80 #define STATUS_CARD_BUS_CLK_RUN (1 << 8)
81 #define STATUS_BUF_READ_RDY (1 << 7)
82 #define STATUS_BUF_WRITE_RDY (1 << 6)
83 #define STATUS_RESP_CRC_ERR (1 << 5)
84 #define STATUS_CRC_READ_ERR (1 << 3)
85 #define STATUS_CRC_WRITE_ERR (1 << 2)
86 #define STATUS_TIME_OUT_RESP (1 << 1)
87 #define STATUS_TIME_OUT_READ (1 << 0)
88 #define STATUS_ERR_MASK 0x2f
90 #define CMD_DAT_CONT_CMD_RESP_LONG_OFF (1 << 12)
91 #define CMD_DAT_CONT_STOP_READWAIT (1 << 11)
92 #define CMD_DAT_CONT_START_READWAIT (1 << 10)
93 #define CMD_DAT_CONT_BUS_WIDTH_4 (2 << 8)
94 #define CMD_DAT_CONT_INIT (1 << 7)
95 #define CMD_DAT_CONT_WRITE (1 << 4)
96 #define CMD_DAT_CONT_DATA_ENABLE (1 << 3)
97 #define CMD_DAT_CONT_RESPONSE_48BIT_CRC (1 << 0)
98 #define CMD_DAT_CONT_RESPONSE_136BIT (2 << 0)
99 #define CMD_DAT_CONT_RESPONSE_48BIT (3 << 0)
101 #define INT_SDIO_INT_WKP_EN (1 << 18)
102 #define INT_CARD_INSERTION_WKP_EN (1 << 17)
103 #define INT_CARD_REMOVAL_WKP_EN (1 << 16)
104 #define INT_CARD_INSERTION_EN (1 << 15)
105 #define INT_CARD_REMOVAL_EN (1 << 14)
106 #define INT_SDIO_IRQ_EN (1 << 13)
107 #define INT_DAT0_EN (1 << 12)
108 #define INT_BUF_READ_EN (1 << 4)
109 #define INT_BUF_WRITE_EN (1 << 3)
110 #define INT_END_CMD_RES_EN (1 << 2)
111 #define INT_WRITE_OP_DONE_EN (1 << 1)
112 #define INT_READ_OP_EN (1 << 0)
115 struct mmc_host *mmc;
116 struct resource *res;
122 unsigned int power_mode;
123 struct imxmmc_platform_data *pdata;
125 struct mmc_request *req;
126 struct mmc_command *cmd;
127 struct mmc_data *data;
129 unsigned int dma_nents;
130 unsigned int datasize;
131 unsigned int dma_dir;
140 struct work_struct datawork;
143 static void mxcmci_set_clk_rate(struct mxcmci_host *host, unsigned int clk_ios);
145 static inline int mxcmci_use_dma(struct mxcmci_host *host)
150 static void mxcmci_softreset(struct mxcmci_host *host)
155 writew(STR_STP_CLK_RESET, host->base + MMC_REG_STR_STP_CLK);
156 writew(STR_STP_CLK_RESET | STR_STP_CLK_START_CLK,
157 host->base + MMC_REG_STR_STP_CLK);
159 for (i = 0; i < 8; i++)
160 writew(STR_STP_CLK_START_CLK, host->base + MMC_REG_STR_STP_CLK);
162 writew(0xff, host->base + MMC_REG_RES_TO);
165 static int mxcmci_setup_data(struct mxcmci_host *host, struct mmc_data *data)
167 unsigned int nob = data->blocks;
168 unsigned int blksz = data->blksz;
169 unsigned int datasize = nob * blksz;
171 struct scatterlist *sg;
175 if (data->flags & MMC_DATA_STREAM)
179 data->bytes_xfered = 0;
181 writew(nob, host->base + MMC_REG_NOB);
182 writew(blksz, host->base + MMC_REG_BLK_LEN);
183 host->datasize = datasize;
186 for_each_sg(data->sg, sg, data->sg_len, i) {
187 if (sg->offset & 3 || sg->length & 3) {
193 if (data->flags & MMC_DATA_READ) {
194 host->dma_dir = DMA_FROM_DEVICE;
195 host->dma_nents = dma_map_sg(mmc_dev(host->mmc), data->sg,
196 data->sg_len, host->dma_dir);
198 ret = imx_dma_setup_sg(host->dma, data->sg, host->dma_nents,
200 host->res->start + MMC_REG_BUFFER_ACCESS,
203 host->dma_dir = DMA_TO_DEVICE;
204 host->dma_nents = dma_map_sg(mmc_dev(host->mmc), data->sg,
205 data->sg_len, host->dma_dir);
207 ret = imx_dma_setup_sg(host->dma, data->sg, host->dma_nents,
209 host->res->start + MMC_REG_BUFFER_ACCESS,
214 dev_err(mmc_dev(host->mmc), "failed to setup DMA : %d\n", ret);
219 imx_dma_enable(host->dma);
224 static int mxcmci_start_cmd(struct mxcmci_host *host, struct mmc_command *cmd,
227 WARN_ON(host->cmd != NULL);
230 switch (mmc_resp_type(cmd)) {
231 case MMC_RSP_R1: /* short CRC, OPCODE */
232 case MMC_RSP_R1B:/* short CRC, OPCODE, BUSY */
233 cmdat |= CMD_DAT_CONT_RESPONSE_48BIT_CRC;
235 case MMC_RSP_R2: /* long 136 bit + CRC */
236 cmdat |= CMD_DAT_CONT_RESPONSE_136BIT;
238 case MMC_RSP_R3: /* short */
239 cmdat |= CMD_DAT_CONT_RESPONSE_48BIT;
244 dev_err(mmc_dev(host->mmc), "unhandled response type 0x%x\n",
246 cmd->error = -EINVAL;
250 if (mxcmci_use_dma(host))
251 writel(INT_READ_OP_EN | INT_WRITE_OP_DONE_EN |
253 host->base + MMC_REG_INT_CNTR);
255 writel(INT_END_CMD_RES_EN, host->base + MMC_REG_INT_CNTR);
257 writew(cmd->opcode, host->base + MMC_REG_CMD);
258 writel(cmd->arg, host->base + MMC_REG_ARG);
259 writew(cmdat, host->base + MMC_REG_CMD_DAT_CONT);
264 static void mxcmci_finish_request(struct mxcmci_host *host,
265 struct mmc_request *req)
267 writel(0, host->base + MMC_REG_INT_CNTR);
273 mmc_request_done(host->mmc, req);
276 static int mxcmci_finish_data(struct mxcmci_host *host, unsigned int stat)
278 struct mmc_data *data = host->data;
282 if (mxcmci_use_dma(host)) {
283 imx_dma_disable(host->dma);
284 dma_unmap_sg(mmc_dev(host->mmc), data->sg, host->dma_nents,
289 if (stat & STATUS_ERR_MASK) {
290 dev_dbg(mmc_dev(host->mmc), "request failed. status: 0x%08x\n",
292 if (stat & STATUS_CRC_READ_ERR) {
293 data->error = -EILSEQ;
294 } else if (stat & STATUS_CRC_WRITE_ERR) {
295 u32 err_code = (stat >> 9) & 0x3;
296 if (err_code == 2) /* No CRC response */
297 data->error = -ETIMEDOUT;
299 data->error = -EILSEQ;
300 } else if (stat & STATUS_TIME_OUT_READ) {
301 data->error = -ETIMEDOUT;
306 data->bytes_xfered = host->datasize;
309 data_error = data->error;
316 static void mxcmci_read_response(struct mxcmci_host *host, unsigned int stat)
318 struct mmc_command *cmd = host->cmd;
325 if (stat & STATUS_TIME_OUT_RESP) {
326 dev_dbg(mmc_dev(host->mmc), "CMD TIMEOUT\n");
327 cmd->error = -ETIMEDOUT;
328 } else if (stat & STATUS_RESP_CRC_ERR && cmd->flags & MMC_RSP_CRC) {
329 dev_dbg(mmc_dev(host->mmc), "cmd crc error\n");
330 cmd->error = -EILSEQ;
333 if (cmd->flags & MMC_RSP_PRESENT) {
334 if (cmd->flags & MMC_RSP_136) {
335 for (i = 0; i < 4; i++) {
336 a = readw(host->base + MMC_REG_RES_FIFO);
337 b = readw(host->base + MMC_REG_RES_FIFO);
338 cmd->resp[i] = a << 16 | b;
341 a = readw(host->base + MMC_REG_RES_FIFO);
342 b = readw(host->base + MMC_REG_RES_FIFO);
343 c = readw(host->base + MMC_REG_RES_FIFO);
344 cmd->resp[0] = a << 24 | b << 8 | c >> 8;
349 static int mxcmci_poll_status(struct mxcmci_host *host, u32 mask)
352 unsigned long timeout = jiffies + HZ;
355 stat = readl(host->base + MMC_REG_STATUS);
356 if (stat & STATUS_ERR_MASK)
358 if (time_after(jiffies, timeout)) {
359 mxcmci_softreset(host);
360 mxcmci_set_clk_rate(host, host->clock);
361 return STATUS_TIME_OUT_READ;
369 static int mxcmci_pull(struct mxcmci_host *host, void *_buf, int bytes)
375 stat = mxcmci_poll_status(host,
376 STATUS_BUF_READ_RDY | STATUS_READ_OP_DONE);
379 *buf++ = readl(host->base + MMC_REG_BUFFER_ACCESS);
387 stat = mxcmci_poll_status(host,
388 STATUS_BUF_READ_RDY | STATUS_READ_OP_DONE);
391 tmp = readl(host->base + MMC_REG_BUFFER_ACCESS);
392 memcpy(b, &tmp, bytes);
398 static int mxcmci_push(struct mxcmci_host *host, void *_buf, int bytes)
404 stat = mxcmci_poll_status(host, STATUS_BUF_WRITE_RDY);
407 writel(*buf++, host->base + MMC_REG_BUFFER_ACCESS);
415 stat = mxcmci_poll_status(host, STATUS_BUF_WRITE_RDY);
419 memcpy(&tmp, b, bytes);
420 writel(tmp, host->base + MMC_REG_BUFFER_ACCESS);
423 stat = mxcmci_poll_status(host, STATUS_BUF_WRITE_RDY);
430 static int mxcmci_transfer_data(struct mxcmci_host *host)
432 struct mmc_data *data = host->req->data;
433 struct scatterlist *sg;
441 if (data->flags & MMC_DATA_READ) {
442 for_each_sg(data->sg, sg, data->sg_len, i) {
443 stat = mxcmci_pull(host, sg_virt(sg), sg->length);
446 host->datasize += sg->length;
449 for_each_sg(data->sg, sg, data->sg_len, i) {
450 stat = mxcmci_push(host, sg_virt(sg), sg->length);
453 host->datasize += sg->length;
455 stat = mxcmci_poll_status(host, STATUS_WRITE_OP_DONE);
462 static void mxcmci_datawork(struct work_struct *work)
464 struct mxcmci_host *host = container_of(work, struct mxcmci_host,
466 int datastat = mxcmci_transfer_data(host);
467 mxcmci_finish_data(host, datastat);
469 if (host->req->stop) {
470 if (mxcmci_start_cmd(host, host->req->stop, 0)) {
471 mxcmci_finish_request(host, host->req);
475 mxcmci_finish_request(host, host->req);
480 static void mxcmci_data_done(struct mxcmci_host *host, unsigned int stat)
482 struct mmc_data *data = host->data;
488 data_error = mxcmci_finish_data(host, stat);
490 mxcmci_read_response(host, stat);
493 if (host->req->stop) {
494 if (mxcmci_start_cmd(host, host->req->stop, 0)) {
495 mxcmci_finish_request(host, host->req);
499 mxcmci_finish_request(host, host->req);
504 static void mxcmci_cmd_done(struct mxcmci_host *host, unsigned int stat)
506 mxcmci_read_response(host, stat);
509 if (!host->data && host->req) {
510 mxcmci_finish_request(host, host->req);
514 /* For the DMA case the DMA engine handles the data transfer
515 * automatically. For non DMA we have to to it ourselves.
516 * Don't do it in interrupt context though.
518 if (!mxcmci_use_dma(host) && host->data)
519 schedule_work(&host->datawork);
523 static irqreturn_t mxcmci_irq(int irq, void *devid)
525 struct mxcmci_host *host = devid;
528 stat = readl(host->base + MMC_REG_STATUS);
529 writel(stat, host->base + MMC_REG_STATUS);
531 dev_dbg(mmc_dev(host->mmc), "%s: 0x%08x\n", __func__, stat);
533 if (stat & STATUS_END_CMD_RESP)
534 mxcmci_cmd_done(host, stat);
536 if (mxcmci_use_dma(host) &&
537 (stat & (STATUS_DATA_TRANS_DONE | STATUS_WRITE_OP_DONE)))
538 mxcmci_data_done(host, stat);
543 static void mxcmci_request(struct mmc_host *mmc, struct mmc_request *req)
545 struct mxcmci_host *host = mmc_priv(mmc);
546 unsigned int cmdat = host->cmdat;
549 WARN_ON(host->req != NULL);
552 host->cmdat &= ~CMD_DAT_CONT_INIT;
557 error = mxcmci_setup_data(host, req->data);
559 req->cmd->error = error;
564 cmdat |= CMD_DAT_CONT_DATA_ENABLE;
566 if (req->data->flags & MMC_DATA_WRITE)
567 cmdat |= CMD_DAT_CONT_WRITE;
570 error = mxcmci_start_cmd(host, req->cmd, cmdat);
573 mxcmci_finish_request(host, req);
576 static void mxcmci_set_clk_rate(struct mxcmci_host *host, unsigned int clk_ios)
578 unsigned int divider;
580 unsigned int clk_in = clk_get_rate(host->clk);
582 while (prescaler <= 0x800) {
583 for (divider = 1; divider <= 0xF; divider++) {
586 x = (clk_in / (divider + 1));
589 x /= (prescaler * 2);
603 writew((prescaler << 4) | divider, host->base + MMC_REG_CLK_RATE);
605 dev_dbg(mmc_dev(host->mmc), "scaler: %d divider: %d in: %d out: %d\n",
606 prescaler, divider, clk_in, clk_ios);
609 static void mxcmci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
611 struct mxcmci_host *host = mmc_priv(mmc);
615 * use burstlen of 64 in 4 bit mode (--> reg value 0)
616 * use burstlen of 16 in 1 bit mode (--> reg value 16)
618 if (ios->bus_width == MMC_BUS_WIDTH_4)
623 imx_dma_config_burstlen(host->dma, blen);
625 if (ios->bus_width == MMC_BUS_WIDTH_4)
626 host->cmdat |= CMD_DAT_CONT_BUS_WIDTH_4;
628 host->cmdat &= ~CMD_DAT_CONT_BUS_WIDTH_4;
630 if (host->power_mode != ios->power_mode) {
631 if (host->pdata && host->pdata->setpower)
632 host->pdata->setpower(mmc_dev(mmc), ios->vdd);
633 host->power_mode = ios->power_mode;
634 if (ios->power_mode == MMC_POWER_ON)
635 host->cmdat |= CMD_DAT_CONT_INIT;
639 mxcmci_set_clk_rate(host, ios->clock);
640 writew(STR_STP_CLK_START_CLK, host->base + MMC_REG_STR_STP_CLK);
642 writew(STR_STP_CLK_STOP_CLK, host->base + MMC_REG_STR_STP_CLK);
645 host->clock = ios->clock;
648 static irqreturn_t mxcmci_detect_irq(int irq, void *data)
650 struct mmc_host *mmc = data;
652 dev_dbg(mmc_dev(mmc), "%s\n", __func__);
654 mmc_detect_change(mmc, msecs_to_jiffies(250));
658 static int mxcmci_get_ro(struct mmc_host *mmc)
660 struct mxcmci_host *host = mmc_priv(mmc);
662 if (host->pdata && host->pdata->get_ro)
663 return !!host->pdata->get_ro(mmc_dev(mmc));
665 * Board doesn't support read only detection; let the mmc core
672 static const struct mmc_host_ops mxcmci_ops = {
673 .request = mxcmci_request,
674 .set_ios = mxcmci_set_ios,
675 .get_ro = mxcmci_get_ro,
678 static int mxcmci_probe(struct platform_device *pdev)
680 struct mmc_host *mmc;
681 struct mxcmci_host *host = NULL;
685 printk(KERN_INFO "i.MX SDHC driver\n");
687 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
688 irq = platform_get_irq(pdev, 0);
692 r = request_mem_region(r->start, resource_size(r), pdev->name);
696 mmc = mmc_alloc_host(sizeof(struct mxcmci_host), &pdev->dev);
699 goto out_release_mem;
702 mmc->ops = &mxcmci_ops;
703 mmc->caps = MMC_CAP_4_BIT_DATA;
705 /* MMC core transfer sizes tunable parameters */
706 mmc->max_hw_segs = 64;
707 mmc->max_phys_segs = 64;
708 mmc->max_blk_size = 2048;
709 mmc->max_blk_count = 65535;
710 mmc->max_req_size = mmc->max_blk_size * mmc->max_blk_count;
711 mmc->max_seg_size = mmc->max_seg_size;
713 host = mmc_priv(mmc);
714 host->base = ioremap(r->start, resource_size(r));
721 host->pdata = pdev->dev.platform_data;
723 if (host->pdata && host->pdata->ocr_avail)
724 mmc->ocr_avail = host->pdata->ocr_avail;
726 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
731 host->clk = clk_get(&pdev->dev, NULL);
732 if (IS_ERR(host->clk)) {
733 ret = PTR_ERR(host->clk);
736 clk_enable(host->clk);
738 mxcmci_softreset(host);
740 host->rev_no = readw(host->base + MMC_REG_REV_NO);
741 if (host->rev_no != 0x400) {
743 dev_err(mmc_dev(host->mmc), "wrong rev.no. 0x%08x. aborting.\n",
748 mmc->f_min = clk_get_rate(host->clk) >> 16;
749 if (mmc->f_min < 400000)
751 mmc->f_max = clk_get_rate(host->clk) >> 1;
753 /* recommended in data sheet */
754 writew(0x2db4, host->base + MMC_REG_READ_TO);
756 writel(0, host->base + MMC_REG_INT_CNTR);
759 host->dma = imx_dma_request_by_prio(DRIVER_NAME, DMA_PRIO_LOW);
761 dev_err(mmc_dev(host->mmc), "imx_dma_request_by_prio failed\n");
766 r = platform_get_resource(pdev, IORESOURCE_DMA, 0);
772 ret = imx_dma_config_channel(host->dma,
773 IMX_DMA_MEMSIZE_32 | IMX_DMA_TYPE_FIFO,
774 IMX_DMA_MEMSIZE_32 | IMX_DMA_TYPE_LINEAR,
777 dev_err(mmc_dev(host->mmc), "failed to config DMA channel\n");
781 INIT_WORK(&host->datawork, mxcmci_datawork);
783 ret = request_irq(host->irq, mxcmci_irq, 0, DRIVER_NAME, host);
787 platform_set_drvdata(pdev, mmc);
789 if (host->pdata && host->pdata->init) {
790 ret = host->pdata->init(&pdev->dev, mxcmci_detect_irq,
801 free_irq(host->irq, host);
804 imx_dma_free(host->dma);
807 clk_disable(host->clk);
814 release_mem_region(host->res->start, resource_size(host->res));
818 static int mxcmci_remove(struct platform_device *pdev)
820 struct mmc_host *mmc = platform_get_drvdata(pdev);
821 struct mxcmci_host *host = mmc_priv(mmc);
823 platform_set_drvdata(pdev, NULL);
825 mmc_remove_host(mmc);
827 if (host->pdata && host->pdata->exit)
828 host->pdata->exit(&pdev->dev, mmc);
830 free_irq(host->irq, host);
833 imx_dma_free(host->dma);
835 clk_disable(host->clk);
838 release_mem_region(host->res->start, resource_size(host->res));
839 release_resource(host->res);
847 static int mxcmci_suspend(struct platform_device *dev, pm_message_t state)
849 struct mmc_host *mmc = platform_get_drvdata(dev);
853 ret = mmc_suspend_host(mmc, state);
858 static int mxcmci_resume(struct platform_device *dev)
860 struct mmc_host *mmc = platform_get_drvdata(dev);
861 struct mxcmci_host *host;
865 host = mmc_priv(mmc);
866 ret = mmc_resume_host(mmc);
872 #define mxcmci_suspend NULL
873 #define mxcmci_resume NULL
874 #endif /* CONFIG_PM */
876 static struct platform_driver mxcmci_driver = {
877 .probe = mxcmci_probe,
878 .remove = mxcmci_remove,
879 .suspend = mxcmci_suspend,
880 .resume = mxcmci_resume,
883 .owner = THIS_MODULE,
887 static int __init mxcmci_init(void)
889 return platform_driver_register(&mxcmci_driver);
892 static void __exit mxcmci_exit(void)
894 platform_driver_unregister(&mxcmci_driver);
897 module_init(mxcmci_init);
898 module_exit(mxcmci_exit);
900 MODULE_DESCRIPTION("i.MX Multimedia Card Interface Driver");
901 MODULE_AUTHOR("Sascha Hauer, Pengutronix");
902 MODULE_LICENSE("GPL");
903 MODULE_ALIAS("platform:imx-mmc");