1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Copyright (C) 2013, Imagination Technologies
6 * JZ4740 SD/MMC controller driver
9 #include <linux/bitops.h>
10 #include <linux/clk.h>
11 #include <linux/delay.h>
12 #include <linux/dmaengine.h>
13 #include <linux/dma-mapping.h>
14 #include <linux/err.h>
15 #include <linux/interrupt.h>
17 #include <linux/irq.h>
18 #include <linux/mmc/host.h>
19 #include <linux/mmc/slot-gpio.h>
20 #include <linux/module.h>
22 #include <linux/pinctrl/consumer.h>
23 #include <linux/platform_device.h>
24 #include <linux/property.h>
25 #include <linux/regulator/consumer.h>
26 #include <linux/scatterlist.h>
28 #include <asm/cacheflush.h>
30 #define JZ_REG_MMC_STRPCL 0x00
31 #define JZ_REG_MMC_STATUS 0x04
32 #define JZ_REG_MMC_CLKRT 0x08
33 #define JZ_REG_MMC_CMDAT 0x0C
34 #define JZ_REG_MMC_RESTO 0x10
35 #define JZ_REG_MMC_RDTO 0x14
36 #define JZ_REG_MMC_BLKLEN 0x18
37 #define JZ_REG_MMC_NOB 0x1C
38 #define JZ_REG_MMC_SNOB 0x20
39 #define JZ_REG_MMC_IMASK 0x24
40 #define JZ_REG_MMC_IREG 0x28
41 #define JZ_REG_MMC_CMD 0x2C
42 #define JZ_REG_MMC_ARG 0x30
43 #define JZ_REG_MMC_RESP_FIFO 0x34
44 #define JZ_REG_MMC_RXFIFO 0x38
45 #define JZ_REG_MMC_TXFIFO 0x3C
46 #define JZ_REG_MMC_LPM 0x40
47 #define JZ_REG_MMC_DMAC 0x44
49 #define JZ_MMC_STRPCL_EXIT_MULTIPLE BIT(7)
50 #define JZ_MMC_STRPCL_EXIT_TRANSFER BIT(6)
51 #define JZ_MMC_STRPCL_START_READWAIT BIT(5)
52 #define JZ_MMC_STRPCL_STOP_READWAIT BIT(4)
53 #define JZ_MMC_STRPCL_RESET BIT(3)
54 #define JZ_MMC_STRPCL_START_OP BIT(2)
55 #define JZ_MMC_STRPCL_CLOCK_CONTROL (BIT(1) | BIT(0))
56 #define JZ_MMC_STRPCL_CLOCK_STOP BIT(0)
57 #define JZ_MMC_STRPCL_CLOCK_START BIT(1)
60 #define JZ_MMC_STATUS_IS_RESETTING BIT(15)
61 #define JZ_MMC_STATUS_SDIO_INT_ACTIVE BIT(14)
62 #define JZ_MMC_STATUS_PRG_DONE BIT(13)
63 #define JZ_MMC_STATUS_DATA_TRAN_DONE BIT(12)
64 #define JZ_MMC_STATUS_END_CMD_RES BIT(11)
65 #define JZ_MMC_STATUS_DATA_FIFO_AFULL BIT(10)
66 #define JZ_MMC_STATUS_IS_READWAIT BIT(9)
67 #define JZ_MMC_STATUS_CLK_EN BIT(8)
68 #define JZ_MMC_STATUS_DATA_FIFO_FULL BIT(7)
69 #define JZ_MMC_STATUS_DATA_FIFO_EMPTY BIT(6)
70 #define JZ_MMC_STATUS_CRC_RES_ERR BIT(5)
71 #define JZ_MMC_STATUS_CRC_READ_ERROR BIT(4)
72 #define JZ_MMC_STATUS_TIMEOUT_WRITE BIT(3)
73 #define JZ_MMC_STATUS_CRC_WRITE_ERROR BIT(2)
74 #define JZ_MMC_STATUS_TIMEOUT_RES BIT(1)
75 #define JZ_MMC_STATUS_TIMEOUT_READ BIT(0)
77 #define JZ_MMC_STATUS_READ_ERROR_MASK (BIT(4) | BIT(0))
78 #define JZ_MMC_STATUS_WRITE_ERROR_MASK (BIT(3) | BIT(2))
81 #define JZ_MMC_CMDAT_IO_ABORT BIT(11)
82 #define JZ_MMC_CMDAT_BUS_WIDTH_4BIT BIT(10)
83 #define JZ_MMC_CMDAT_BUS_WIDTH_8BIT (BIT(10) | BIT(9))
84 #define JZ_MMC_CMDAT_BUS_WIDTH_MASK (BIT(10) | BIT(9))
85 #define JZ_MMC_CMDAT_DMA_EN BIT(8)
86 #define JZ_MMC_CMDAT_INIT BIT(7)
87 #define JZ_MMC_CMDAT_BUSY BIT(6)
88 #define JZ_MMC_CMDAT_STREAM BIT(5)
89 #define JZ_MMC_CMDAT_WRITE BIT(4)
90 #define JZ_MMC_CMDAT_DATA_EN BIT(3)
91 #define JZ_MMC_CMDAT_RESPONSE_FORMAT (BIT(2) | BIT(1) | BIT(0))
92 #define JZ_MMC_CMDAT_RSP_R1 1
93 #define JZ_MMC_CMDAT_RSP_R2 2
94 #define JZ_MMC_CMDAT_RSP_R3 3
96 #define JZ_MMC_IRQ_SDIO BIT(7)
97 #define JZ_MMC_IRQ_TXFIFO_WR_REQ BIT(6)
98 #define JZ_MMC_IRQ_RXFIFO_RD_REQ BIT(5)
99 #define JZ_MMC_IRQ_END_CMD_RES BIT(2)
100 #define JZ_MMC_IRQ_PRG_DONE BIT(1)
101 #define JZ_MMC_IRQ_DATA_TRAN_DONE BIT(0)
103 #define JZ_MMC_DMAC_DMA_SEL BIT(1)
104 #define JZ_MMC_DMAC_DMA_EN BIT(0)
106 #define JZ_MMC_LPM_DRV_RISING BIT(31)
107 #define JZ_MMC_LPM_DRV_RISING_QTR_PHASE_DLY BIT(31)
108 #define JZ_MMC_LPM_DRV_RISING_1NS_DLY BIT(30)
109 #define JZ_MMC_LPM_SMP_RISING_QTR_OR_HALF_PHASE_DLY BIT(29)
110 #define JZ_MMC_LPM_LOW_POWER_MODE_EN BIT(0)
112 #define JZ_MMC_CLK_RATE 24000000
113 #define JZ_MMC_REQ_TIMEOUT_MS 5000
115 enum jz4740_mmc_version {
123 enum jz4740_mmc_state {
124 JZ4740_MMC_STATE_READ_RESPONSE,
125 JZ4740_MMC_STATE_TRANSFER_DATA,
126 JZ4740_MMC_STATE_SEND_STOP,
127 JZ4740_MMC_STATE_DONE,
131 * The MMC core allows to prepare a mmc_request while another mmc_request
132 * is in-flight. This is used via the pre_req/post_req hooks.
133 * This driver uses the pre_req/post_req hooks to map/unmap the mmc_request.
134 * Following what other drivers do (sdhci, dw_mmc) we use the following cookie
135 * flags to keep track of the mmc_request mapping state.
137 * COOKIE_UNMAPPED: the request is not mapped.
138 * COOKIE_PREMAPPED: the request was mapped in pre_req,
139 * and should be unmapped in post_req.
140 * COOKIE_MAPPED: the request was mapped in the irq handler,
141 * and should be unmapped before mmc_request_done is called..
149 struct jz4740_mmc_host {
150 struct mmc_host *mmc;
151 struct platform_device *pdev;
154 enum jz4740_mmc_version version;
159 struct resource *mem_res;
160 struct mmc_request *req;
161 struct mmc_command *cmd;
165 unsigned long waiting;
173 struct timer_list timeout_timer;
174 struct sg_mapping_iter miter;
175 enum jz4740_mmc_state state;
178 struct dma_chan *dma_rx;
179 struct dma_chan *dma_tx;
182 /* The DMA trigger level is 8 words, that is to say, the DMA read
183 * trigger is when data words in MSC_RXFIFO is >= 8 and the DMA write
184 * trigger is when data words in MSC_TXFIFO is < 8.
186 #define JZ4740_MMC_FIFO_HALF_SIZE 8
189 static void jz4740_mmc_write_irq_mask(struct jz4740_mmc_host *host,
192 if (host->version >= JZ_MMC_JZ4725B)
193 return writel(val, host->base + JZ_REG_MMC_IMASK);
195 return writew(val, host->base + JZ_REG_MMC_IMASK);
198 static void jz4740_mmc_write_irq_reg(struct jz4740_mmc_host *host,
201 if (host->version >= JZ_MMC_JZ4780)
202 writel(val, host->base + JZ_REG_MMC_IREG);
204 writew(val, host->base + JZ_REG_MMC_IREG);
207 static uint32_t jz4740_mmc_read_irq_reg(struct jz4740_mmc_host *host)
209 if (host->version >= JZ_MMC_JZ4780)
210 return readl(host->base + JZ_REG_MMC_IREG);
212 return readw(host->base + JZ_REG_MMC_IREG);
215 /*----------------------------------------------------------------------------*/
216 /* DMA infrastructure */
218 static void jz4740_mmc_release_dma_channels(struct jz4740_mmc_host *host)
223 dma_release_channel(host->dma_tx);
225 dma_release_channel(host->dma_rx);
228 static int jz4740_mmc_acquire_dma_channels(struct jz4740_mmc_host *host)
230 struct device *dev = mmc_dev(host->mmc);
232 host->dma_tx = dma_request_chan(dev, "tx-rx");
233 if (!IS_ERR(host->dma_tx))
236 if (PTR_ERR(host->dma_tx) != -ENODEV) {
237 dev_err(dev, "Failed to get dma tx-rx channel\n");
238 return PTR_ERR(host->dma_tx);
241 host->dma_tx = dma_request_chan(mmc_dev(host->mmc), "tx");
242 if (IS_ERR(host->dma_tx)) {
243 dev_err(mmc_dev(host->mmc), "Failed to get dma_tx channel\n");
244 return PTR_ERR(host->dma_tx);
247 host->dma_rx = dma_request_chan(mmc_dev(host->mmc), "rx");
248 if (IS_ERR(host->dma_rx)) {
249 dev_err(mmc_dev(host->mmc), "Failed to get dma_rx channel\n");
250 dma_release_channel(host->dma_tx);
251 return PTR_ERR(host->dma_rx);
255 * Limit the maximum segment size in any SG entry according to
256 * the parameters of the DMA engine device.
259 struct device *dev = host->dma_tx->device->dev;
260 unsigned int max_seg_size = dma_get_max_seg_size(dev);
262 if (max_seg_size < host->mmc->max_seg_size)
263 host->mmc->max_seg_size = max_seg_size;
267 struct device *dev = host->dma_rx->device->dev;
268 unsigned int max_seg_size = dma_get_max_seg_size(dev);
270 if (max_seg_size < host->mmc->max_seg_size)
271 host->mmc->max_seg_size = max_seg_size;
277 static inline struct dma_chan *jz4740_mmc_get_dma_chan(struct jz4740_mmc_host *host,
278 struct mmc_data *data)
280 if ((data->flags & MMC_DATA_READ) && host->dma_rx)
286 static void jz4740_mmc_dma_unmap(struct jz4740_mmc_host *host,
287 struct mmc_data *data)
289 struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
290 enum dma_data_direction dir = mmc_get_dma_dir(data);
292 dma_unmap_sg(chan->device->dev, data->sg, data->sg_len, dir);
293 data->host_cookie = COOKIE_UNMAPPED;
296 /* Prepares DMA data for current or next transfer.
297 * A request can be in-flight when this is called.
299 static int jz4740_mmc_prepare_dma_data(struct jz4740_mmc_host *host,
300 struct mmc_data *data,
303 struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
304 enum dma_data_direction dir = mmc_get_dma_dir(data);
305 unsigned int sg_count;
307 if (data->host_cookie == COOKIE_PREMAPPED)
308 return data->sg_count;
310 sg_count = dma_map_sg(chan->device->dev,
316 dev_err(mmc_dev(host->mmc),
317 "Failed to map scatterlist for DMA operation\n");
321 data->sg_count = sg_count;
322 data->host_cookie = cookie;
324 return data->sg_count;
327 static int jz4740_mmc_start_dma_transfer(struct jz4740_mmc_host *host,
328 struct mmc_data *data)
330 struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
331 struct dma_async_tx_descriptor *desc;
332 struct dma_slave_config conf = {
333 .src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES,
334 .dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES,
335 .src_maxburst = JZ4740_MMC_FIFO_HALF_SIZE,
336 .dst_maxburst = JZ4740_MMC_FIFO_HALF_SIZE,
340 if (data->flags & MMC_DATA_WRITE) {
341 conf.direction = DMA_MEM_TO_DEV;
342 conf.dst_addr = host->mem_res->start + JZ_REG_MMC_TXFIFO;
344 conf.direction = DMA_DEV_TO_MEM;
345 conf.src_addr = host->mem_res->start + JZ_REG_MMC_RXFIFO;
348 sg_count = jz4740_mmc_prepare_dma_data(host, data, COOKIE_MAPPED);
352 dmaengine_slave_config(chan, &conf);
353 desc = dmaengine_prep_slave_sg(chan, data->sg, sg_count,
355 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
357 dev_err(mmc_dev(host->mmc),
358 "Failed to allocate DMA %s descriptor",
359 conf.direction == DMA_MEM_TO_DEV ? "TX" : "RX");
363 dmaengine_submit(desc);
364 dma_async_issue_pending(chan);
369 if (data->host_cookie == COOKIE_MAPPED)
370 jz4740_mmc_dma_unmap(host, data);
374 static void jz4740_mmc_pre_request(struct mmc_host *mmc,
375 struct mmc_request *mrq)
377 struct jz4740_mmc_host *host = mmc_priv(mmc);
378 struct mmc_data *data = mrq->data;
383 data->host_cookie = COOKIE_UNMAPPED;
384 if (jz4740_mmc_prepare_dma_data(host, data, COOKIE_PREMAPPED) < 0)
385 data->host_cookie = COOKIE_UNMAPPED;
388 static void jz4740_mmc_post_request(struct mmc_host *mmc,
389 struct mmc_request *mrq,
392 struct jz4740_mmc_host *host = mmc_priv(mmc);
393 struct mmc_data *data = mrq->data;
395 if (data && data->host_cookie != COOKIE_UNMAPPED)
396 jz4740_mmc_dma_unmap(host, data);
399 struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
401 dmaengine_terminate_all(chan);
405 /*----------------------------------------------------------------------------*/
407 static void jz4740_mmc_set_irq_enabled(struct jz4740_mmc_host *host,
408 unsigned int irq, bool enabled)
412 spin_lock_irqsave(&host->lock, flags);
414 host->irq_mask &= ~irq;
416 host->irq_mask |= irq;
418 jz4740_mmc_write_irq_mask(host, host->irq_mask);
419 spin_unlock_irqrestore(&host->lock, flags);
422 static void jz4740_mmc_clock_enable(struct jz4740_mmc_host *host,
425 uint16_t val = JZ_MMC_STRPCL_CLOCK_START;
428 val |= JZ_MMC_STRPCL_START_OP;
430 writew(val, host->base + JZ_REG_MMC_STRPCL);
433 static void jz4740_mmc_clock_disable(struct jz4740_mmc_host *host)
436 unsigned int timeout = 1000;
438 writew(JZ_MMC_STRPCL_CLOCK_STOP, host->base + JZ_REG_MMC_STRPCL);
440 status = readl(host->base + JZ_REG_MMC_STATUS);
441 } while (status & JZ_MMC_STATUS_CLK_EN && --timeout);
444 static void jz4740_mmc_reset(struct jz4740_mmc_host *host)
447 unsigned int timeout = 1000;
449 writew(JZ_MMC_STRPCL_RESET, host->base + JZ_REG_MMC_STRPCL);
452 status = readl(host->base + JZ_REG_MMC_STATUS);
453 } while (status & JZ_MMC_STATUS_IS_RESETTING && --timeout);
456 static void jz4740_mmc_request_done(struct jz4740_mmc_host *host)
458 struct mmc_request *req;
459 struct mmc_data *data;
465 if (data && data->host_cookie == COOKIE_MAPPED)
466 jz4740_mmc_dma_unmap(host, data);
467 mmc_request_done(host->mmc, req);
470 static unsigned int jz4740_mmc_poll_irq(struct jz4740_mmc_host *host,
473 unsigned int timeout = 0x800;
477 status = jz4740_mmc_read_irq_reg(host);
478 } while (!(status & irq) && --timeout);
481 set_bit(0, &host->waiting);
482 mod_timer(&host->timeout_timer,
483 jiffies + msecs_to_jiffies(JZ_MMC_REQ_TIMEOUT_MS));
484 jz4740_mmc_set_irq_enabled(host, irq, true);
491 static void jz4740_mmc_transfer_check_state(struct jz4740_mmc_host *host,
492 struct mmc_data *data)
496 status = readl(host->base + JZ_REG_MMC_STATUS);
497 if (status & JZ_MMC_STATUS_WRITE_ERROR_MASK) {
498 if (status & (JZ_MMC_STATUS_TIMEOUT_WRITE)) {
499 host->req->cmd->error = -ETIMEDOUT;
500 data->error = -ETIMEDOUT;
502 host->req->cmd->error = -EIO;
505 } else if (status & JZ_MMC_STATUS_READ_ERROR_MASK) {
506 if (status & (JZ_MMC_STATUS_TIMEOUT_READ)) {
507 host->req->cmd->error = -ETIMEDOUT;
508 data->error = -ETIMEDOUT;
510 host->req->cmd->error = -EIO;
516 static bool jz4740_mmc_write_data(struct jz4740_mmc_host *host,
517 struct mmc_data *data)
519 struct sg_mapping_iter *miter = &host->miter;
520 void __iomem *fifo_addr = host->base + JZ_REG_MMC_TXFIFO;
525 while (sg_miter_next(miter)) {
527 i = miter->length / 4;
531 timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_TXFIFO_WR_REQ);
532 if (unlikely(timeout))
535 writel(buf[0], fifo_addr);
536 writel(buf[1], fifo_addr);
537 writel(buf[2], fifo_addr);
538 writel(buf[3], fifo_addr);
539 writel(buf[4], fifo_addr);
540 writel(buf[5], fifo_addr);
541 writel(buf[6], fifo_addr);
542 writel(buf[7], fifo_addr);
547 timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_TXFIFO_WR_REQ);
548 if (unlikely(timeout))
552 writel(*buf, fifo_addr);
557 data->bytes_xfered += miter->length;
559 sg_miter_stop(miter);
564 miter->consumed = (void *)buf - miter->addr;
565 data->bytes_xfered += miter->consumed;
566 sg_miter_stop(miter);
571 static bool jz4740_mmc_read_data(struct jz4740_mmc_host *host,
572 struct mmc_data *data)
574 struct sg_mapping_iter *miter = &host->miter;
575 void __iomem *fifo_addr = host->base + JZ_REG_MMC_RXFIFO;
580 unsigned int timeout;
582 while (sg_miter_next(miter)) {
588 timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_RXFIFO_RD_REQ);
589 if (unlikely(timeout))
592 buf[0] = readl(fifo_addr);
593 buf[1] = readl(fifo_addr);
594 buf[2] = readl(fifo_addr);
595 buf[3] = readl(fifo_addr);
596 buf[4] = readl(fifo_addr);
597 buf[5] = readl(fifo_addr);
598 buf[6] = readl(fifo_addr);
599 buf[7] = readl(fifo_addr);
606 timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_RXFIFO_RD_REQ);
607 if (unlikely(timeout))
611 *buf++ = readl(fifo_addr);
614 if (unlikely(i > 0)) {
615 d = readl(fifo_addr);
619 data->bytes_xfered += miter->length;
621 sg_miter_stop(miter);
623 /* For whatever reason there is sometime one word more in the fifo then
626 status = readl(host->base + JZ_REG_MMC_STATUS);
627 while (!(status & JZ_MMC_STATUS_DATA_FIFO_EMPTY) && --timeout) {
628 d = readl(fifo_addr);
629 status = readl(host->base + JZ_REG_MMC_STATUS);
635 miter->consumed = (void *)buf - miter->addr;
636 data->bytes_xfered += miter->consumed;
637 sg_miter_stop(miter);
642 static void jz4740_mmc_timeout(struct timer_list *t)
644 struct jz4740_mmc_host *host = from_timer(host, t, timeout_timer);
646 if (!test_and_clear_bit(0, &host->waiting))
649 jz4740_mmc_set_irq_enabled(host, JZ_MMC_IRQ_END_CMD_RES, false);
651 host->req->cmd->error = -ETIMEDOUT;
652 jz4740_mmc_request_done(host);
655 static void jz4740_mmc_read_response(struct jz4740_mmc_host *host,
656 struct mmc_command *cmd)
660 void __iomem *fifo_addr = host->base + JZ_REG_MMC_RESP_FIFO;
662 if (cmd->flags & MMC_RSP_136) {
663 tmp = readw(fifo_addr);
664 for (i = 0; i < 4; ++i) {
665 cmd->resp[i] = tmp << 24;
666 tmp = readw(fifo_addr);
667 cmd->resp[i] |= tmp << 8;
668 tmp = readw(fifo_addr);
669 cmd->resp[i] |= tmp >> 8;
672 cmd->resp[0] = readw(fifo_addr) << 24;
673 cmd->resp[0] |= readw(fifo_addr) << 8;
674 cmd->resp[0] |= readw(fifo_addr) & 0xff;
678 static void jz4740_mmc_send_command(struct jz4740_mmc_host *host,
679 struct mmc_command *cmd)
681 uint32_t cmdat = host->cmdat;
683 host->cmdat &= ~JZ_MMC_CMDAT_INIT;
684 jz4740_mmc_clock_disable(host);
688 if (cmd->flags & MMC_RSP_BUSY)
689 cmdat |= JZ_MMC_CMDAT_BUSY;
691 switch (mmc_resp_type(cmd)) {
694 cmdat |= JZ_MMC_CMDAT_RSP_R1;
697 cmdat |= JZ_MMC_CMDAT_RSP_R2;
700 cmdat |= JZ_MMC_CMDAT_RSP_R3;
707 cmdat |= JZ_MMC_CMDAT_DATA_EN;
708 if (cmd->data->flags & MMC_DATA_WRITE)
709 cmdat |= JZ_MMC_CMDAT_WRITE;
712 * The JZ4780's MMC controller has integrated DMA ability
713 * in addition to being able to use the external DMA
714 * controller. It moves DMA control bits to a separate
715 * register. The DMA_SEL bit chooses the external
716 * controller over the integrated one. Earlier SoCs
717 * can only use the external controller, and have a
718 * single DMA enable bit in CMDAT.
720 if (host->version >= JZ_MMC_JZ4780) {
721 writel(JZ_MMC_DMAC_DMA_EN | JZ_MMC_DMAC_DMA_SEL,
722 host->base + JZ_REG_MMC_DMAC);
724 cmdat |= JZ_MMC_CMDAT_DMA_EN;
726 } else if (host->version >= JZ_MMC_JZ4780) {
727 writel(0, host->base + JZ_REG_MMC_DMAC);
730 writew(cmd->data->blksz, host->base + JZ_REG_MMC_BLKLEN);
731 writew(cmd->data->blocks, host->base + JZ_REG_MMC_NOB);
734 writeb(cmd->opcode, host->base + JZ_REG_MMC_CMD);
735 writel(cmd->arg, host->base + JZ_REG_MMC_ARG);
736 writel(cmdat, host->base + JZ_REG_MMC_CMDAT);
738 jz4740_mmc_clock_enable(host, 1);
741 static void jz_mmc_prepare_data_transfer(struct jz4740_mmc_host *host)
743 struct mmc_command *cmd = host->req->cmd;
744 struct mmc_data *data = cmd->data;
747 if (data->flags & MMC_DATA_READ)
748 direction = SG_MITER_TO_SG;
750 direction = SG_MITER_FROM_SG;
752 sg_miter_start(&host->miter, data->sg, data->sg_len, direction);
756 static irqreturn_t jz_mmc_irq_worker(int irq, void *devid)
758 struct jz4740_mmc_host *host = (struct jz4740_mmc_host *)devid;
759 struct mmc_command *cmd = host->req->cmd;
760 struct mmc_request *req = host->req;
761 struct mmc_data *data = cmd->data;
762 bool timeout = false;
765 host->state = JZ4740_MMC_STATE_DONE;
767 switch (host->state) {
768 case JZ4740_MMC_STATE_READ_RESPONSE:
769 if (cmd->flags & MMC_RSP_PRESENT)
770 jz4740_mmc_read_response(host, cmd);
775 jz_mmc_prepare_data_transfer(host);
778 case JZ4740_MMC_STATE_TRANSFER_DATA:
780 /* Use DMA if enabled.
781 * Data transfer direction is defined later by
782 * relying on data flags in
783 * jz4740_mmc_prepare_dma_data() and
784 * jz4740_mmc_start_dma_transfer().
786 timeout = jz4740_mmc_start_dma_transfer(host, data);
787 data->bytes_xfered = data->blocks * data->blksz;
788 } else if (data->flags & MMC_DATA_READ)
789 /* Use PIO if DMA is not enabled.
790 * Data transfer direction was defined before
791 * by relying on data flags in
792 * jz_mmc_prepare_data_transfer().
794 timeout = jz4740_mmc_read_data(host, data);
796 timeout = jz4740_mmc_write_data(host, data);
798 if (unlikely(timeout)) {
799 host->state = JZ4740_MMC_STATE_TRANSFER_DATA;
803 jz4740_mmc_transfer_check_state(host, data);
805 timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_DATA_TRAN_DONE);
806 if (unlikely(timeout)) {
807 host->state = JZ4740_MMC_STATE_SEND_STOP;
810 jz4740_mmc_write_irq_reg(host, JZ_MMC_IRQ_DATA_TRAN_DONE);
813 case JZ4740_MMC_STATE_SEND_STOP:
817 jz4740_mmc_send_command(host, req->stop);
819 if (mmc_resp_type(req->stop) & MMC_RSP_BUSY) {
820 timeout = jz4740_mmc_poll_irq(host,
821 JZ_MMC_IRQ_PRG_DONE);
823 host->state = JZ4740_MMC_STATE_DONE;
829 case JZ4740_MMC_STATE_DONE:
834 jz4740_mmc_request_done(host);
839 static irqreturn_t jz_mmc_irq(int irq, void *devid)
841 struct jz4740_mmc_host *host = devid;
842 struct mmc_command *cmd = host->cmd;
843 uint32_t irq_reg, status, tmp;
845 status = readl(host->base + JZ_REG_MMC_STATUS);
846 irq_reg = jz4740_mmc_read_irq_reg(host);
849 irq_reg &= ~host->irq_mask;
851 tmp &= ~(JZ_MMC_IRQ_TXFIFO_WR_REQ | JZ_MMC_IRQ_RXFIFO_RD_REQ |
852 JZ_MMC_IRQ_PRG_DONE | JZ_MMC_IRQ_DATA_TRAN_DONE);
855 jz4740_mmc_write_irq_reg(host, tmp & ~irq_reg);
857 if (irq_reg & JZ_MMC_IRQ_SDIO) {
858 jz4740_mmc_write_irq_reg(host, JZ_MMC_IRQ_SDIO);
859 mmc_signal_sdio_irq(host->mmc);
860 irq_reg &= ~JZ_MMC_IRQ_SDIO;
863 if (host->req && cmd && irq_reg) {
864 if (test_and_clear_bit(0, &host->waiting)) {
865 del_timer(&host->timeout_timer);
867 if (status & JZ_MMC_STATUS_TIMEOUT_RES) {
868 cmd->error = -ETIMEDOUT;
869 } else if (status & JZ_MMC_STATUS_CRC_RES_ERR) {
871 } else if (status & (JZ_MMC_STATUS_CRC_READ_ERROR |
872 JZ_MMC_STATUS_CRC_WRITE_ERROR)) {
874 cmd->data->error = -EIO;
878 jz4740_mmc_set_irq_enabled(host, irq_reg, false);
879 jz4740_mmc_write_irq_reg(host, irq_reg);
881 return IRQ_WAKE_THREAD;
888 static int jz4740_mmc_set_clock_rate(struct jz4740_mmc_host *host, int rate)
893 jz4740_mmc_clock_disable(host);
894 clk_set_rate(host->clk, host->mmc->f_max);
896 real_rate = clk_get_rate(host->clk);
898 while (real_rate > rate && div < 7) {
903 writew(div, host->base + JZ_REG_MMC_CLKRT);
905 if (real_rate > 25000000) {
906 if (host->version >= JZ_MMC_JZ4780) {
907 writel(JZ_MMC_LPM_DRV_RISING_QTR_PHASE_DLY |
908 JZ_MMC_LPM_SMP_RISING_QTR_OR_HALF_PHASE_DLY |
909 JZ_MMC_LPM_LOW_POWER_MODE_EN,
910 host->base + JZ_REG_MMC_LPM);
911 } else if (host->version >= JZ_MMC_JZ4760) {
912 writel(JZ_MMC_LPM_DRV_RISING |
913 JZ_MMC_LPM_LOW_POWER_MODE_EN,
914 host->base + JZ_REG_MMC_LPM);
915 } else if (host->version >= JZ_MMC_JZ4725B)
916 writel(JZ_MMC_LPM_LOW_POWER_MODE_EN,
917 host->base + JZ_REG_MMC_LPM);
923 static void jz4740_mmc_request(struct mmc_host *mmc, struct mmc_request *req)
925 struct jz4740_mmc_host *host = mmc_priv(mmc);
929 jz4740_mmc_write_irq_reg(host, ~0);
930 jz4740_mmc_set_irq_enabled(host, JZ_MMC_IRQ_END_CMD_RES, true);
932 host->state = JZ4740_MMC_STATE_READ_RESPONSE;
933 set_bit(0, &host->waiting);
934 mod_timer(&host->timeout_timer,
935 jiffies + msecs_to_jiffies(JZ_MMC_REQ_TIMEOUT_MS));
936 jz4740_mmc_send_command(host, req->cmd);
939 static void jz4740_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
941 struct jz4740_mmc_host *host = mmc_priv(mmc);
945 jz4740_mmc_set_clock_rate(host, ios->clock);
947 switch (ios->power_mode) {
949 jz4740_mmc_reset(host);
950 if (!IS_ERR(mmc->supply.vmmc))
951 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, ios->vdd);
952 host->cmdat |= JZ_MMC_CMDAT_INIT;
953 clk_prepare_enable(host->clk);
956 if (!IS_ERR(mmc->supply.vqmmc) && !host->vqmmc_enabled) {
957 ret = regulator_enable(mmc->supply.vqmmc);
959 dev_err(&host->pdev->dev, "Failed to set vqmmc power!\n");
961 host->vqmmc_enabled = true;
965 if (!IS_ERR(mmc->supply.vmmc))
966 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, 0);
967 if (!IS_ERR(mmc->supply.vqmmc) && host->vqmmc_enabled) {
968 regulator_disable(mmc->supply.vqmmc);
969 host->vqmmc_enabled = false;
971 clk_disable_unprepare(host->clk);
977 switch (ios->bus_width) {
978 case MMC_BUS_WIDTH_1:
979 host->cmdat &= ~JZ_MMC_CMDAT_BUS_WIDTH_MASK;
981 case MMC_BUS_WIDTH_4:
982 host->cmdat &= ~JZ_MMC_CMDAT_BUS_WIDTH_MASK;
983 host->cmdat |= JZ_MMC_CMDAT_BUS_WIDTH_4BIT;
985 case MMC_BUS_WIDTH_8:
986 host->cmdat &= ~JZ_MMC_CMDAT_BUS_WIDTH_MASK;
987 host->cmdat |= JZ_MMC_CMDAT_BUS_WIDTH_8BIT;
994 static void jz4740_mmc_enable_sdio_irq(struct mmc_host *mmc, int enable)
996 struct jz4740_mmc_host *host = mmc_priv(mmc);
997 jz4740_mmc_set_irq_enabled(host, JZ_MMC_IRQ_SDIO, enable);
1000 static int jz4740_voltage_switch(struct mmc_host *mmc, struct mmc_ios *ios)
1004 /* vqmmc regulator is available */
1005 if (!IS_ERR(mmc->supply.vqmmc)) {
1006 ret = mmc_regulator_set_vqmmc(mmc, ios);
1007 return ret < 0 ? ret : 0;
1010 /* no vqmmc regulator, assume fixed regulator at 3/3.3V */
1011 if (ios->signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1017 static const struct mmc_host_ops jz4740_mmc_ops = {
1018 .request = jz4740_mmc_request,
1019 .pre_req = jz4740_mmc_pre_request,
1020 .post_req = jz4740_mmc_post_request,
1021 .set_ios = jz4740_mmc_set_ios,
1022 .get_ro = mmc_gpio_get_ro,
1023 .get_cd = mmc_gpio_get_cd,
1024 .enable_sdio_irq = jz4740_mmc_enable_sdio_irq,
1025 .start_signal_voltage_switch = jz4740_voltage_switch,
1028 static const struct of_device_id jz4740_mmc_of_match[] = {
1029 { .compatible = "ingenic,jz4740-mmc", .data = (void *) JZ_MMC_JZ4740 },
1030 { .compatible = "ingenic,jz4725b-mmc", .data = (void *)JZ_MMC_JZ4725B },
1031 { .compatible = "ingenic,jz4760-mmc", .data = (void *) JZ_MMC_JZ4760 },
1032 { .compatible = "ingenic,jz4775-mmc", .data = (void *) JZ_MMC_JZ4780 },
1033 { .compatible = "ingenic,jz4780-mmc", .data = (void *) JZ_MMC_JZ4780 },
1034 { .compatible = "ingenic,x1000-mmc", .data = (void *) JZ_MMC_X1000 },
1037 MODULE_DEVICE_TABLE(of, jz4740_mmc_of_match);
1039 static int jz4740_mmc_probe(struct platform_device* pdev)
1042 struct mmc_host *mmc;
1043 struct jz4740_mmc_host *host;
1045 mmc = mmc_alloc_host(sizeof(struct jz4740_mmc_host), &pdev->dev);
1047 dev_err(&pdev->dev, "Failed to alloc mmc host structure\n");
1051 host = mmc_priv(mmc);
1053 /* Default if no match is JZ4740 */
1054 host->version = (enum jz4740_mmc_version)device_get_match_data(&pdev->dev);
1056 ret = mmc_of_parse(mmc);
1058 dev_err_probe(&pdev->dev, ret, "could not parse device properties\n");
1062 mmc_regulator_get_supply(mmc);
1064 host->irq = platform_get_irq(pdev, 0);
1065 if (host->irq < 0) {
1070 host->clk = devm_clk_get(&pdev->dev, "mmc");
1071 if (IS_ERR(host->clk)) {
1072 ret = PTR_ERR(host->clk);
1073 dev_err(&pdev->dev, "Failed to get mmc clock\n");
1077 host->base = devm_platform_get_and_ioremap_resource(pdev, 0, &host->mem_res);
1078 if (IS_ERR(host->base)) {
1079 ret = PTR_ERR(host->base);
1083 mmc->ops = &jz4740_mmc_ops;
1085 mmc->f_max = JZ_MMC_CLK_RATE;
1088 * There seems to be a problem with this driver on the JZ4760 and
1089 * JZ4760B SoCs. There, when using the maximum rate supported (50 MHz),
1090 * the communication fails with many SD cards.
1091 * Until this bug is sorted out, limit the maximum rate to 24 MHz.
1093 if (host->version == JZ_MMC_JZ4760 && mmc->f_max > JZ_MMC_CLK_RATE)
1094 mmc->f_max = JZ_MMC_CLK_RATE;
1096 mmc->f_min = mmc->f_max / 128;
1097 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
1100 * We use a fixed timeout of 5s, hence inform the core about it. A
1101 * future improvement should instead respect the cmd->busy_timeout.
1103 mmc->max_busy_timeout = JZ_MMC_REQ_TIMEOUT_MS;
1105 mmc->max_blk_size = (1 << 10) - 1;
1106 mmc->max_blk_count = (1 << 15) - 1;
1107 mmc->max_req_size = mmc->max_blk_size * mmc->max_blk_count;
1109 mmc->max_segs = 128;
1110 mmc->max_seg_size = mmc->max_req_size;
1114 spin_lock_init(&host->lock);
1115 host->irq_mask = ~0;
1117 jz4740_mmc_reset(host);
1119 ret = request_threaded_irq(host->irq, jz_mmc_irq, jz_mmc_irq_worker, 0,
1120 dev_name(&pdev->dev), host);
1122 dev_err(&pdev->dev, "Failed to request irq: %d\n", ret);
1126 jz4740_mmc_clock_disable(host);
1127 timer_setup(&host->timeout_timer, jz4740_mmc_timeout, 0);
1129 ret = jz4740_mmc_acquire_dma_channels(host);
1130 if (ret == -EPROBE_DEFER)
1132 host->use_dma = !ret;
1134 platform_set_drvdata(pdev, host);
1135 ret = mmc_add_host(mmc);
1138 dev_err(&pdev->dev, "Failed to add mmc host: %d\n", ret);
1139 goto err_release_dma;
1141 dev_info(&pdev->dev, "Ingenic SD/MMC card driver registered\n");
1143 dev_info(&pdev->dev, "Using %s, %d-bit mode\n",
1144 host->use_dma ? "DMA" : "PIO",
1145 (mmc->caps & MMC_CAP_8_BIT_DATA) ? 8 :
1146 ((mmc->caps & MMC_CAP_4_BIT_DATA) ? 4 : 1));
1152 jz4740_mmc_release_dma_channels(host);
1154 free_irq(host->irq, host);
1161 static void jz4740_mmc_remove(struct platform_device *pdev)
1163 struct jz4740_mmc_host *host = platform_get_drvdata(pdev);
1165 del_timer_sync(&host->timeout_timer);
1166 jz4740_mmc_set_irq_enabled(host, 0xff, false);
1167 jz4740_mmc_reset(host);
1169 mmc_remove_host(host->mmc);
1171 free_irq(host->irq, host);
1174 jz4740_mmc_release_dma_channels(host);
1176 mmc_free_host(host->mmc);
1179 static int jz4740_mmc_suspend(struct device *dev)
1181 return pinctrl_pm_select_sleep_state(dev);
1184 static int jz4740_mmc_resume(struct device *dev)
1186 return pinctrl_select_default_state(dev);
1189 static DEFINE_SIMPLE_DEV_PM_OPS(jz4740_mmc_pm_ops, jz4740_mmc_suspend,
1192 static struct platform_driver jz4740_mmc_driver = {
1193 .probe = jz4740_mmc_probe,
1194 .remove = jz4740_mmc_remove,
1196 .name = "jz4740-mmc",
1197 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1198 .of_match_table = jz4740_mmc_of_match,
1199 .pm = pm_sleep_ptr(&jz4740_mmc_pm_ops),
1203 module_platform_driver(jz4740_mmc_driver);
1205 MODULE_DESCRIPTION("JZ4740 SD/MMC controller driver");
1206 MODULE_LICENSE("GPL");