1 // SPDX-License-Identifier: GPL-2.0
3 * Driver for the MMC / SD / SDIO IP found in:
5 * TC6393XB, TC6391XB, TC6387XB, T7L66XB, ASIC3, SH-Mobile SoCs
7 * Copyright (C) 2015-19 Renesas Electronics Corporation
8 * Copyright (C) 2016-19 Sang Engineering, Wolfram Sang
9 * Copyright (C) 2017 Horms Solutions, Simon Horman
10 * Copyright (C) 2011 Guennadi Liakhovetski
11 * Copyright (C) 2007 Ian Molton
12 * Copyright (C) 2004 Ian Molton
14 * This driver draws mainly on scattered spec sheets, Reverse engineering
15 * of the toshiba e800 SD driver and some parts of the 2.4 ASIC3 driver (4 bit
16 * support). (Further 4 bit support from a later datasheet).
19 * Investigate using a workqueue for PIO transfers
21 * Better Power management
22 * Handle MMC errors better
23 * double buffer support
27 #include <linux/delay.h>
28 #include <linux/device.h>
29 #include <linux/dma-mapping.h>
30 #include <linux/highmem.h>
31 #include <linux/interrupt.h>
33 #include <linux/irq.h>
34 #include <linux/mfd/tmio.h>
35 #include <linux/mmc/card.h>
36 #include <linux/mmc/host.h>
37 #include <linux/mmc/mmc.h>
38 #include <linux/mmc/slot-gpio.h>
39 #include <linux/module.h>
40 #include <linux/pagemap.h>
41 #include <linux/platform_device.h>
42 #include <linux/pm_qos.h>
43 #include <linux/pm_runtime.h>
44 #include <linux/regulator/consumer.h>
45 #include <linux/mmc/sdio.h>
46 #include <linux/scatterlist.h>
47 #include <linux/sizes.h>
48 #include <linux/spinlock.h>
49 #include <linux/workqueue.h>
53 static inline void tmio_mmc_start_dma(struct tmio_mmc_host *host,
54 struct mmc_data *data)
57 host->dma_ops->start(host, data);
60 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host *host, bool enable)
63 host->dma_ops->enable(host, enable);
66 static inline void tmio_mmc_request_dma(struct tmio_mmc_host *host,
67 struct tmio_mmc_data *pdata)
70 host->dma_ops->request(host, pdata);
77 static inline void tmio_mmc_release_dma(struct tmio_mmc_host *host)
80 host->dma_ops->release(host);
83 static inline void tmio_mmc_abort_dma(struct tmio_mmc_host *host)
86 host->dma_ops->abort(host);
89 static inline void tmio_mmc_dataend_dma(struct tmio_mmc_host *host)
92 host->dma_ops->dataend(host);
95 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i)
97 host->sdcard_irq_mask &= ~(i & TMIO_MASK_IRQ);
98 sd_ctrl_write32_as_16_and_16(host, CTL_IRQ_MASK, host->sdcard_irq_mask);
100 EXPORT_SYMBOL_GPL(tmio_mmc_enable_mmc_irqs);
102 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i)
104 host->sdcard_irq_mask |= (i & TMIO_MASK_IRQ);
105 sd_ctrl_write32_as_16_and_16(host, CTL_IRQ_MASK, host->sdcard_irq_mask);
107 EXPORT_SYMBOL_GPL(tmio_mmc_disable_mmc_irqs);
109 static void tmio_mmc_ack_mmc_irqs(struct tmio_mmc_host *host, u32 i)
111 sd_ctrl_write32_as_16_and_16(host, CTL_STATUS, ~i);
114 static void tmio_mmc_init_sg(struct tmio_mmc_host *host, struct mmc_data *data)
116 host->sg_len = data->sg_len;
117 host->sg_ptr = data->sg;
118 host->sg_orig = data->sg;
122 static int tmio_mmc_next_sg(struct tmio_mmc_host *host)
124 host->sg_ptr = sg_next(host->sg_ptr);
126 return --host->sg_len;
129 #define CMDREQ_TIMEOUT 5000
131 static void tmio_mmc_enable_sdio_irq(struct mmc_host *mmc, int enable)
133 struct tmio_mmc_host *host = mmc_priv(mmc);
135 if (enable && !host->sdio_irq_enabled) {
138 /* Keep device active while SDIO irq is enabled */
139 pm_runtime_get_sync(mmc_dev(mmc));
141 host->sdio_irq_enabled = true;
142 host->sdio_irq_mask = TMIO_SDIO_MASK_ALL & ~TMIO_SDIO_STAT_IOIRQ;
144 /* Clear obsolete interrupts before enabling */
145 sdio_status = sd_ctrl_read16(host, CTL_SDIO_STATUS) & ~TMIO_SDIO_MASK_ALL;
146 if (host->pdata->flags & TMIO_MMC_SDIO_STATUS_SETBITS)
147 sdio_status |= TMIO_SDIO_SETBITS_MASK;
148 sd_ctrl_write16(host, CTL_SDIO_STATUS, sdio_status);
150 sd_ctrl_write16(host, CTL_SDIO_IRQ_MASK, host->sdio_irq_mask);
151 } else if (!enable && host->sdio_irq_enabled) {
152 host->sdio_irq_mask = TMIO_SDIO_MASK_ALL;
153 sd_ctrl_write16(host, CTL_SDIO_IRQ_MASK, host->sdio_irq_mask);
155 host->sdio_irq_enabled = false;
156 pm_runtime_mark_last_busy(mmc_dev(mmc));
157 pm_runtime_put_autosuspend(mmc_dev(mmc));
161 static void tmio_mmc_reset(struct tmio_mmc_host *host)
163 /* FIXME - should we set stop clock reg here */
164 sd_ctrl_write16(host, CTL_RESET_SD, 0x0000);
165 usleep_range(10000, 11000);
166 sd_ctrl_write16(host, CTL_RESET_SD, 0x0001);
167 usleep_range(10000, 11000);
169 if (host->pdata->flags & TMIO_MMC_SDIO_IRQ) {
170 sd_ctrl_write16(host, CTL_SDIO_IRQ_MASK, host->sdio_irq_mask);
171 sd_ctrl_write16(host, CTL_TRANSACTION_CTL, 0x0001);
175 static void tmio_mmc_hw_reset(struct mmc_host *mmc)
177 struct tmio_mmc_host *host = mmc_priv(mmc);
181 tmio_mmc_abort_dma(host);
184 host->hw_reset(host);
187 static void tmio_mmc_reset_work(struct work_struct *work)
189 struct tmio_mmc_host *host = container_of(work, struct tmio_mmc_host,
190 delayed_reset_work.work);
191 struct mmc_request *mrq;
194 spin_lock_irqsave(&host->lock, flags);
198 * is request already finished? Since we use a non-blocking
199 * cancel_delayed_work(), it can happen, that a .set_ios() call preempts
200 * us, so, have to check for IS_ERR(host->mrq)
202 if (IS_ERR_OR_NULL(mrq) ||
203 time_is_after_jiffies(host->last_req_ts +
204 msecs_to_jiffies(CMDREQ_TIMEOUT))) {
205 spin_unlock_irqrestore(&host->lock, flags);
209 dev_warn(&host->pdev->dev,
210 "timeout waiting for hardware interrupt (CMD%u)\n",
214 host->data->error = -ETIMEDOUT;
216 host->cmd->error = -ETIMEDOUT;
218 mrq->cmd->error = -ETIMEDOUT;
223 spin_unlock_irqrestore(&host->lock, flags);
225 tmio_mmc_hw_reset(host->mmc);
227 /* Ready for new calls */
230 mmc_request_done(host->mmc, mrq);
233 /* These are the bitmasks the tmio chip requires to implement the MMC response
234 * types. Note that R1 and R6 are the same in this scheme. */
235 #define APP_CMD 0x0040
236 #define RESP_NONE 0x0300
237 #define RESP_R1 0x0400
238 #define RESP_R1B 0x0500
239 #define RESP_R2 0x0600
240 #define RESP_R3 0x0700
241 #define DATA_PRESENT 0x0800
242 #define TRANSFER_READ 0x1000
243 #define TRANSFER_MULTI 0x2000
244 #define SECURITY_CMD 0x4000
245 #define NO_CMD12_ISSUE 0x4000 /* TMIO_MMC_HAVE_CMD12_CTRL */
247 static int tmio_mmc_start_command(struct tmio_mmc_host *host,
248 struct mmc_command *cmd)
250 struct mmc_data *data = host->data;
253 switch (mmc_resp_type(cmd)) {
254 case MMC_RSP_NONE: c |= RESP_NONE; break;
256 case MMC_RSP_R1_NO_CRC:
258 case MMC_RSP_R1B: c |= RESP_R1B; break;
259 case MMC_RSP_R2: c |= RESP_R2; break;
260 case MMC_RSP_R3: c |= RESP_R3; break;
262 pr_debug("Unknown response type %d\n", mmc_resp_type(cmd));
268 /* FIXME - this seems to be ok commented out but the spec suggest this bit
269 * should be set when issuing app commands.
270 * if(cmd->flags & MMC_FLAG_ACMD)
275 if (data->blocks > 1) {
276 sd_ctrl_write16(host, CTL_STOP_INTERNAL_ACTION, TMIO_STOP_SEC);
280 * Disable auto CMD12 at IO_RW_EXTENDED and
281 * SET_BLOCK_COUNT when doing multiple block transfer
283 if ((host->pdata->flags & TMIO_MMC_HAVE_CMD12_CTRL) &&
284 (cmd->opcode == SD_IO_RW_EXTENDED || host->mrq->sbc))
287 if (data->flags & MMC_DATA_READ)
291 tmio_mmc_enable_mmc_irqs(host, TMIO_MASK_CMD);
293 /* Fire off the command */
294 sd_ctrl_write32_as_16_and_16(host, CTL_ARG_REG, cmd->arg);
295 sd_ctrl_write16(host, CTL_SD_CMD, c);
300 static void tmio_mmc_transfer_data(struct tmio_mmc_host *host,
304 int is_read = host->data->flags & MMC_DATA_READ;
310 if (host->pdata->flags & TMIO_MMC_32BIT_DATA_PORT) {
312 u32 *buf32 = (u32 *)buf;
315 sd_ctrl_read32_rep(host, CTL_SD_DATA_PORT, buf32,
318 sd_ctrl_write32_rep(host, CTL_SD_DATA_PORT, buf32,
321 /* if count was multiple of 4 */
329 sd_ctrl_read32_rep(host, CTL_SD_DATA_PORT, &data, 1);
330 memcpy(buf32, &data, count);
332 memcpy(&data, buf32, count);
333 sd_ctrl_write32_rep(host, CTL_SD_DATA_PORT, &data, 1);
340 sd_ctrl_read16_rep(host, CTL_SD_DATA_PORT, buf, count >> 1);
342 sd_ctrl_write16_rep(host, CTL_SD_DATA_PORT, buf, count >> 1);
344 /* if count was even number */
348 /* if count was odd number */
349 buf8 = (u8 *)(buf + (count >> 1));
354 * driver and this function are assuming that
355 * it is used as little endian
358 *buf8 = sd_ctrl_read16(host, CTL_SD_DATA_PORT) & 0xff;
360 sd_ctrl_write16(host, CTL_SD_DATA_PORT, *buf8);
364 * This chip always returns (at least?) as much data as you ask for.
365 * I'm unsure what happens if you ask for less than a block. This should be
366 * looked into to ensure that a funny length read doesn't hose the controller.
368 static void tmio_mmc_pio_irq(struct tmio_mmc_host *host)
370 struct mmc_data *data = host->data;
377 pr_err("PIO IRQ in DMA mode!\n");
380 pr_debug("Spurious PIO IRQ\n");
384 sg_virt = tmio_mmc_kmap_atomic(host->sg_ptr, &flags);
385 buf = (unsigned short *)(sg_virt + host->sg_off);
387 count = host->sg_ptr->length - host->sg_off;
388 if (count > data->blksz)
391 pr_debug("count: %08x offset: %08x flags %08x\n",
392 count, host->sg_off, data->flags);
394 /* Transfer the data */
395 tmio_mmc_transfer_data(host, buf, count);
397 host->sg_off += count;
399 tmio_mmc_kunmap_atomic(host->sg_ptr, &flags, sg_virt);
401 if (host->sg_off == host->sg_ptr->length)
402 tmio_mmc_next_sg(host);
405 static void tmio_mmc_check_bounce_buffer(struct tmio_mmc_host *host)
407 if (host->sg_ptr == &host->bounce_sg) {
409 void *sg_vaddr = tmio_mmc_kmap_atomic(host->sg_orig, &flags);
411 memcpy(sg_vaddr, host->bounce_buf, host->bounce_sg.length);
412 tmio_mmc_kunmap_atomic(host->sg_orig, &flags, sg_vaddr);
416 /* needs to be called with host->lock held */
417 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host)
419 struct mmc_data *data = host->data;
420 struct mmc_command *stop;
425 dev_warn(&host->pdev->dev, "Spurious data end IRQ\n");
430 /* FIXME - return correct transfer count on errors */
432 data->bytes_xfered = data->blocks * data->blksz;
434 data->bytes_xfered = 0;
436 pr_debug("Completed data request\n");
439 * FIXME: other drivers allow an optional stop command of any given type
440 * which we dont do, as the chip can auto generate them.
441 * Perhaps we can be smarter about when to use auto CMD12 and
442 * only issue the auto request when we know this is the desired
443 * stop command, allowing fallback to the stop command the
444 * upper layers expect. For now, we do what works.
447 if (data->flags & MMC_DATA_READ) {
449 tmio_mmc_check_bounce_buffer(host);
450 dev_dbg(&host->pdev->dev, "Complete Rx request %p\n",
453 dev_dbg(&host->pdev->dev, "Complete Tx request %p\n",
457 if (stop && !host->mrq->sbc) {
458 if (stop->opcode != MMC_STOP_TRANSMISSION || stop->arg)
459 dev_err(&host->pdev->dev, "unsupported stop: CMD%u,0x%x. We did CMD12,0\n",
460 stop->opcode, stop->arg);
462 /* fill in response from auto CMD12 */
463 stop->resp[0] = sd_ctrl_read16_and_16_as_32(host, CTL_RESPONSE);
465 sd_ctrl_write16(host, CTL_STOP_INTERNAL_ACTION, 0);
468 schedule_work(&host->done);
470 EXPORT_SYMBOL_GPL(tmio_mmc_do_data_irq);
472 static void tmio_mmc_data_irq(struct tmio_mmc_host *host, unsigned int stat)
474 struct mmc_data *data;
476 spin_lock(&host->lock);
482 if (stat & TMIO_STAT_CRCFAIL || stat & TMIO_STAT_STOPBIT_ERR ||
483 stat & TMIO_STAT_TXUNDERRUN)
484 data->error = -EILSEQ;
485 if (host->dma_on && (data->flags & MMC_DATA_WRITE)) {
486 u32 status = sd_ctrl_read16_and_16_as_32(host, CTL_STATUS);
490 * Has all data been written out yet? Testing on SuperH showed,
491 * that in most cases the first interrupt comes already with the
492 * BUSY status bit clear, but on some operations, like mount or
493 * in the beginning of a write / sync / umount, there is one
494 * DATAEND interrupt with the BUSY bit set, in this cases
495 * waiting for one more interrupt fixes the problem.
497 if (host->pdata->flags & TMIO_MMC_HAS_IDLE_WAIT) {
498 if (status & TMIO_STAT_SCLKDIVEN)
501 if (!(status & TMIO_STAT_CMD_BUSY))
506 tmio_mmc_disable_mmc_irqs(host, TMIO_STAT_DATAEND);
507 tmio_mmc_dataend_dma(host);
509 } else if (host->dma_on && (data->flags & MMC_DATA_READ)) {
510 tmio_mmc_disable_mmc_irqs(host, TMIO_STAT_DATAEND);
511 tmio_mmc_dataend_dma(host);
513 tmio_mmc_do_data_irq(host);
514 tmio_mmc_disable_mmc_irqs(host, TMIO_MASK_READOP | TMIO_MASK_WRITEOP);
517 spin_unlock(&host->lock);
520 static void tmio_mmc_cmd_irq(struct tmio_mmc_host *host, unsigned int stat)
522 struct mmc_command *cmd = host->cmd;
525 spin_lock(&host->lock);
528 pr_debug("Spurious CMD irq\n");
532 /* This controller is sicker than the PXA one. Not only do we need to
533 * drop the top 8 bits of the first response word, we also need to
534 * modify the order of the response for short response command types.
537 for (i = 3, addr = CTL_RESPONSE ; i >= 0 ; i--, addr += 4)
538 cmd->resp[i] = sd_ctrl_read16_and_16_as_32(host, addr);
540 if (cmd->flags & MMC_RSP_136) {
541 cmd->resp[0] = (cmd->resp[0] << 8) | (cmd->resp[1] >> 24);
542 cmd->resp[1] = (cmd->resp[1] << 8) | (cmd->resp[2] >> 24);
543 cmd->resp[2] = (cmd->resp[2] << 8) | (cmd->resp[3] >> 24);
545 } else if (cmd->flags & MMC_RSP_R3) {
546 cmd->resp[0] = cmd->resp[3];
549 if (stat & TMIO_STAT_CMDTIMEOUT)
550 cmd->error = -ETIMEDOUT;
551 else if ((stat & TMIO_STAT_CRCFAIL && cmd->flags & MMC_RSP_CRC) ||
552 stat & TMIO_STAT_STOPBIT_ERR ||
553 stat & TMIO_STAT_CMD_IDX_ERR)
554 cmd->error = -EILSEQ;
556 /* If there is data to handle we enable data IRQs here, and
557 * we will ultimatley finish the request in the data_end handler.
558 * If theres no data or we encountered an error, finish now.
560 if (host->data && (!cmd->error || cmd->error == -EILSEQ)) {
561 if (host->data->flags & MMC_DATA_READ) {
563 tmio_mmc_enable_mmc_irqs(host, TMIO_MASK_READOP);
565 tmio_mmc_disable_mmc_irqs(host,
567 tasklet_schedule(&host->dma_issue);
571 tmio_mmc_enable_mmc_irqs(host, TMIO_MASK_WRITEOP);
573 tmio_mmc_disable_mmc_irqs(host,
575 tasklet_schedule(&host->dma_issue);
579 schedule_work(&host->done);
583 spin_unlock(&host->lock);
586 static bool __tmio_mmc_card_detect_irq(struct tmio_mmc_host *host,
587 int ireg, int status)
589 struct mmc_host *mmc = host->mmc;
591 /* Card insert / remove attempts */
592 if (ireg & (TMIO_STAT_CARD_INSERT | TMIO_STAT_CARD_REMOVE)) {
593 tmio_mmc_ack_mmc_irqs(host, TMIO_STAT_CARD_INSERT |
594 TMIO_STAT_CARD_REMOVE);
595 if ((((ireg & TMIO_STAT_CARD_REMOVE) && mmc->card) ||
596 ((ireg & TMIO_STAT_CARD_INSERT) && !mmc->card)) &&
597 !work_pending(&mmc->detect.work))
598 mmc_detect_change(host->mmc, msecs_to_jiffies(100));
605 static bool __tmio_mmc_sdcard_irq(struct tmio_mmc_host *host, int ireg,
608 /* Command completion */
609 if (ireg & (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT)) {
610 tmio_mmc_ack_mmc_irqs(host, TMIO_STAT_CMDRESPEND |
611 TMIO_STAT_CMDTIMEOUT);
612 tmio_mmc_cmd_irq(host, status);
617 if (ireg & (TMIO_STAT_RXRDY | TMIO_STAT_TXRQ)) {
618 tmio_mmc_ack_mmc_irqs(host, TMIO_STAT_RXRDY | TMIO_STAT_TXRQ);
619 tmio_mmc_pio_irq(host);
623 /* Data transfer completion */
624 if (ireg & TMIO_STAT_DATAEND) {
625 tmio_mmc_ack_mmc_irqs(host, TMIO_STAT_DATAEND);
626 tmio_mmc_data_irq(host, status);
633 static bool __tmio_mmc_sdio_irq(struct tmio_mmc_host *host)
635 struct mmc_host *mmc = host->mmc;
636 struct tmio_mmc_data *pdata = host->pdata;
637 unsigned int ireg, status;
638 unsigned int sdio_status;
640 if (!(pdata->flags & TMIO_MMC_SDIO_IRQ))
643 status = sd_ctrl_read16(host, CTL_SDIO_STATUS);
644 ireg = status & TMIO_SDIO_MASK_ALL & ~host->sdio_irq_mask;
646 sdio_status = status & ~TMIO_SDIO_MASK_ALL;
647 if (pdata->flags & TMIO_MMC_SDIO_STATUS_SETBITS)
648 sdio_status |= TMIO_SDIO_SETBITS_MASK;
650 sd_ctrl_write16(host, CTL_SDIO_STATUS, sdio_status);
652 if (mmc->caps & MMC_CAP_SDIO_IRQ && ireg & TMIO_SDIO_STAT_IOIRQ)
653 mmc_signal_sdio_irq(mmc);
658 irqreturn_t tmio_mmc_irq(int irq, void *devid)
660 struct tmio_mmc_host *host = devid;
661 unsigned int ireg, status;
663 status = sd_ctrl_read16_and_16_as_32(host, CTL_STATUS);
664 ireg = status & TMIO_MASK_IRQ & ~host->sdcard_irq_mask;
666 /* Clear the status except the interrupt status */
667 sd_ctrl_write32_as_16_and_16(host, CTL_STATUS, TMIO_MASK_IRQ);
669 if (__tmio_mmc_card_detect_irq(host, ireg, status))
671 if (__tmio_mmc_sdcard_irq(host, ireg, status))
674 if (__tmio_mmc_sdio_irq(host))
679 EXPORT_SYMBOL_GPL(tmio_mmc_irq);
681 static int tmio_mmc_start_data(struct tmio_mmc_host *host,
682 struct mmc_data *data)
684 struct tmio_mmc_data *pdata = host->pdata;
686 pr_debug("setup data transfer: blocksize %08x nr_blocks %d\n",
687 data->blksz, data->blocks);
689 /* Some hardware cannot perform 2 byte requests in 4/8 bit mode */
690 if (host->mmc->ios.bus_width == MMC_BUS_WIDTH_4 ||
691 host->mmc->ios.bus_width == MMC_BUS_WIDTH_8) {
692 int blksz_2bytes = pdata->flags & TMIO_MMC_BLKSZ_2BYTES;
694 if (data->blksz < 2 || (data->blksz < 4 && !blksz_2bytes)) {
695 pr_err("%s: %d byte block unsupported in 4/8 bit mode\n",
696 mmc_hostname(host->mmc), data->blksz);
701 tmio_mmc_init_sg(host, data);
703 host->dma_on = false;
705 /* Set transfer length / blocksize */
706 sd_ctrl_write16(host, CTL_SD_XFER_LEN, data->blksz);
707 if (host->mmc->max_blk_count >= SZ_64K)
708 sd_ctrl_write32(host, CTL_XFER_BLK_COUNT, data->blocks);
710 sd_ctrl_write16(host, CTL_XFER_BLK_COUNT, data->blocks);
712 tmio_mmc_start_dma(host, data);
717 static int tmio_mmc_execute_tuning(struct mmc_host *mmc, u32 opcode)
719 struct tmio_mmc_host *host = mmc_priv(mmc);
722 if (!host->init_tuning || !host->select_tuning)
723 /* Tuning is not supported */
726 host->tap_num = host->init_tuning(host);
728 /* Tuning is not supported */
731 if (host->tap_num * 2 >= sizeof(host->taps) * BITS_PER_BYTE) {
732 dev_warn_once(&host->pdev->dev,
733 "Too many taps, skipping tuning. Please consider updating size of taps field of tmio_mmc_host\n");
737 bitmap_zero(host->taps, host->tap_num * 2);
739 /* Issue CMD19 twice for each tap */
740 for (i = 0; i < 2 * host->tap_num; i++) {
741 if (host->prepare_tuning)
742 host->prepare_tuning(host, i % host->tap_num);
744 ret = mmc_send_tuning(mmc, opcode, NULL);
746 set_bit(i, host->taps);
749 ret = host->select_tuning(host);
753 dev_warn(&host->pdev->dev, "Tuning procedure failed\n");
754 tmio_mmc_hw_reset(mmc);
760 static void tmio_process_mrq(struct tmio_mmc_host *host,
761 struct mmc_request *mrq)
763 struct mmc_command *cmd;
766 if (mrq->sbc && host->cmd != mrq->sbc) {
771 ret = tmio_mmc_start_data(host, mrq->data);
777 ret = tmio_mmc_start_command(host, cmd);
781 schedule_delayed_work(&host->delayed_reset_work,
782 msecs_to_jiffies(CMDREQ_TIMEOUT));
787 mrq->cmd->error = ret;
788 mmc_request_done(host->mmc, mrq);
791 /* Process requests from the MMC layer */
792 static void tmio_mmc_request(struct mmc_host *mmc, struct mmc_request *mrq)
794 struct tmio_mmc_host *host = mmc_priv(mmc);
797 spin_lock_irqsave(&host->lock, flags);
800 pr_debug("request not null\n");
801 if (IS_ERR(host->mrq)) {
802 spin_unlock_irqrestore(&host->lock, flags);
803 mrq->cmd->error = -EAGAIN;
804 mmc_request_done(mmc, mrq);
809 host->last_req_ts = jiffies;
813 spin_unlock_irqrestore(&host->lock, flags);
815 tmio_process_mrq(host, mrq);
818 static void tmio_mmc_finish_request(struct tmio_mmc_host *host)
820 struct mmc_request *mrq;
823 spin_lock_irqsave(&host->lock, flags);
826 if (IS_ERR_OR_NULL(mrq)) {
827 spin_unlock_irqrestore(&host->lock, flags);
831 /* If not SET_BLOCK_COUNT, clear old data */
832 if (host->cmd != mrq->sbc) {
838 cancel_delayed_work(&host->delayed_reset_work);
840 spin_unlock_irqrestore(&host->lock, flags);
842 if (mrq->cmd->error || (mrq->data && mrq->data->error))
843 tmio_mmc_abort_dma(host);
845 /* SCC error means retune, but executed command was still successful */
846 if (host->check_scc_error && host->check_scc_error(host))
847 mmc_retune_needed(host->mmc);
849 /* If SET_BLOCK_COUNT, continue with main command */
850 if (host->mrq && !mrq->cmd->error) {
851 tmio_process_mrq(host, mrq);
855 mmc_request_done(host->mmc, mrq);
858 static void tmio_mmc_done_work(struct work_struct *work)
860 struct tmio_mmc_host *host = container_of(work, struct tmio_mmc_host,
862 tmio_mmc_finish_request(host);
865 static void tmio_mmc_power_on(struct tmio_mmc_host *host, unsigned short vdd)
867 struct mmc_host *mmc = host->mmc;
870 /* .set_ios() is returning void, so, no chance to report an error */
873 host->set_pwr(host->pdev, 1);
875 if (!IS_ERR(mmc->supply.vmmc)) {
876 ret = mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd);
878 * Attention: empiric value. With a b43 WiFi SDIO card this
879 * delay proved necessary for reliable card-insertion probing.
880 * 100us were not enough. Is this the same 140us delay, as in
881 * tmio_mmc_set_ios()?
883 usleep_range(200, 300);
886 * It seems, VccQ should be switched on after Vcc, this is also what the
887 * omap_hsmmc.c driver does.
889 if (!IS_ERR(mmc->supply.vqmmc) && !ret) {
890 ret = regulator_enable(mmc->supply.vqmmc);
891 usleep_range(200, 300);
895 dev_dbg(&host->pdev->dev, "Regulators failed to power up: %d\n",
899 static void tmio_mmc_power_off(struct tmio_mmc_host *host)
901 struct mmc_host *mmc = host->mmc;
903 if (!IS_ERR(mmc->supply.vqmmc))
904 regulator_disable(mmc->supply.vqmmc);
906 if (!IS_ERR(mmc->supply.vmmc))
907 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, 0);
910 host->set_pwr(host->pdev, 0);
913 static void tmio_mmc_set_bus_width(struct tmio_mmc_host *host,
914 unsigned char bus_width)
916 u16 reg = sd_ctrl_read16(host, CTL_SD_MEM_CARD_OPT)
917 & ~(CARD_OPT_WIDTH | CARD_OPT_WIDTH8);
919 /* reg now applies to MMC_BUS_WIDTH_4 */
920 if (bus_width == MMC_BUS_WIDTH_1)
921 reg |= CARD_OPT_WIDTH;
922 else if (bus_width == MMC_BUS_WIDTH_8)
923 reg |= CARD_OPT_WIDTH8;
925 sd_ctrl_write16(host, CTL_SD_MEM_CARD_OPT, reg);
928 /* Set MMC clock / power.
929 * Note: This controller uses a simple divider scheme therefore it cannot
930 * run a MMC card at full speed (20MHz). The max clock is 24MHz on SD, but as
931 * MMC wont run that fast, it has to be clocked at 12MHz which is the next
934 static void tmio_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
936 struct tmio_mmc_host *host = mmc_priv(mmc);
937 struct device *dev = &host->pdev->dev;
940 mutex_lock(&host->ios_lock);
942 spin_lock_irqsave(&host->lock, flags);
944 if (IS_ERR(host->mrq)) {
946 "%s.%d: concurrent .set_ios(), clk %u, mode %u\n",
947 current->comm, task_pid_nr(current),
948 ios->clock, ios->power_mode);
949 host->mrq = ERR_PTR(-EINTR);
952 "%s.%d: CMD%u active since %lu, now %lu!\n",
953 current->comm, task_pid_nr(current),
954 host->mrq->cmd->opcode, host->last_req_ts,
957 spin_unlock_irqrestore(&host->lock, flags);
959 mutex_unlock(&host->ios_lock);
963 host->mrq = ERR_PTR(-EBUSY);
965 spin_unlock_irqrestore(&host->lock, flags);
967 switch (ios->power_mode) {
969 tmio_mmc_power_off(host);
970 host->set_clock(host, 0);
973 tmio_mmc_power_on(host, ios->vdd);
974 host->set_clock(host, ios->clock);
975 tmio_mmc_set_bus_width(host, ios->bus_width);
978 host->set_clock(host, ios->clock);
979 tmio_mmc_set_bus_width(host, ios->bus_width);
983 /* Let things settle. delay taken from winCE driver */
984 usleep_range(140, 200);
985 if (PTR_ERR(host->mrq) == -EINTR)
986 dev_dbg(&host->pdev->dev,
987 "%s.%d: IOS interrupted: clk %u, mode %u",
988 current->comm, task_pid_nr(current),
989 ios->clock, ios->power_mode);
992 host->clk_cache = ios->clock;
994 mutex_unlock(&host->ios_lock);
997 static int tmio_mmc_get_ro(struct mmc_host *mmc)
999 struct tmio_mmc_host *host = mmc_priv(mmc);
1001 return !(sd_ctrl_read16_and_16_as_32(host, CTL_STATUS) &
1002 TMIO_STAT_WRPROTECT);
1005 static int tmio_mmc_get_cd(struct mmc_host *mmc)
1007 struct tmio_mmc_host *host = mmc_priv(mmc);
1009 return !!(sd_ctrl_read16_and_16_as_32(host, CTL_STATUS) &
1010 TMIO_STAT_SIGSTATE);
1013 static int tmio_multi_io_quirk(struct mmc_card *card,
1014 unsigned int direction, int blk_size)
1016 struct tmio_mmc_host *host = mmc_priv(card->host);
1018 if (host->multi_io_quirk)
1019 return host->multi_io_quirk(card, direction, blk_size);
1024 static int tmio_mmc_prepare_hs400_tuning(struct mmc_host *mmc,
1025 struct mmc_ios *ios)
1027 struct tmio_mmc_host *host = mmc_priv(mmc);
1029 if (host->prepare_hs400_tuning)
1030 host->prepare_hs400_tuning(host);
1035 static void tmio_mmc_hs400_downgrade(struct mmc_host *mmc)
1037 struct tmio_mmc_host *host = mmc_priv(mmc);
1039 if (host->hs400_downgrade)
1040 host->hs400_downgrade(host);
1043 static void tmio_mmc_hs400_complete(struct mmc_host *mmc)
1045 struct tmio_mmc_host *host = mmc_priv(mmc);
1047 if (host->hs400_complete)
1048 host->hs400_complete(host);
1051 static const struct mmc_host_ops tmio_mmc_ops = {
1052 .request = tmio_mmc_request,
1053 .set_ios = tmio_mmc_set_ios,
1054 .get_ro = tmio_mmc_get_ro,
1055 .get_cd = tmio_mmc_get_cd,
1056 .enable_sdio_irq = tmio_mmc_enable_sdio_irq,
1057 .multi_io_quirk = tmio_multi_io_quirk,
1058 .hw_reset = tmio_mmc_hw_reset,
1059 .execute_tuning = tmio_mmc_execute_tuning,
1060 .prepare_hs400_tuning = tmio_mmc_prepare_hs400_tuning,
1061 .hs400_downgrade = tmio_mmc_hs400_downgrade,
1062 .hs400_complete = tmio_mmc_hs400_complete,
1065 static int tmio_mmc_init_ocr(struct tmio_mmc_host *host)
1067 struct tmio_mmc_data *pdata = host->pdata;
1068 struct mmc_host *mmc = host->mmc;
1071 err = mmc_regulator_get_supply(mmc);
1075 /* use ocr_mask if no regulator */
1076 if (!mmc->ocr_avail)
1077 mmc->ocr_avail = pdata->ocr_mask;
1081 * There is possibility that regulator has not been probed
1083 if (!mmc->ocr_avail)
1084 return -EPROBE_DEFER;
1089 static void tmio_mmc_of_parse(struct platform_device *pdev,
1090 struct mmc_host *mmc)
1092 const struct device_node *np = pdev->dev.of_node;
1099 * For new platforms, please use "disable-wp" instead of
1100 * "toshiba,mmc-wrprotect-disable"
1102 if (of_get_property(np, "toshiba,mmc-wrprotect-disable", NULL))
1103 mmc->caps2 |= MMC_CAP2_NO_WRITE_PROTECT;
1106 struct tmio_mmc_host *tmio_mmc_host_alloc(struct platform_device *pdev,
1107 struct tmio_mmc_data *pdata)
1109 struct tmio_mmc_host *host;
1110 struct mmc_host *mmc;
1111 struct resource *res;
1115 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1116 ctl = devm_ioremap_resource(&pdev->dev, res);
1118 return ERR_CAST(ctl);
1120 mmc = mmc_alloc_host(sizeof(struct tmio_mmc_host), &pdev->dev);
1122 return ERR_PTR(-ENOMEM);
1124 host = mmc_priv(mmc);
1128 host->pdata = pdata;
1129 host->ops = tmio_mmc_ops;
1130 mmc->ops = &host->ops;
1132 ret = mmc_of_parse(host->mmc);
1134 host = ERR_PTR(ret);
1138 tmio_mmc_of_parse(pdev, mmc);
1140 platform_set_drvdata(pdev, host);
1148 EXPORT_SYMBOL_GPL(tmio_mmc_host_alloc);
1150 void tmio_mmc_host_free(struct tmio_mmc_host *host)
1152 mmc_free_host(host->mmc);
1154 EXPORT_SYMBOL_GPL(tmio_mmc_host_free);
1156 int tmio_mmc_host_probe(struct tmio_mmc_host *_host)
1158 struct platform_device *pdev = _host->pdev;
1159 struct tmio_mmc_data *pdata = _host->pdata;
1160 struct mmc_host *mmc = _host->mmc;
1164 * Check the sanity of mmc->f_min to prevent host->set_clock() from
1165 * looping forever...
1167 if (mmc->f_min == 0)
1170 if (!(pdata->flags & TMIO_MMC_HAS_IDLE_WAIT))
1171 _host->write16_hook = NULL;
1173 _host->set_pwr = pdata->set_pwr;
1175 ret = tmio_mmc_init_ocr(_host);
1180 * Look for a card detect GPIO, if it fails with anything
1181 * else than a probe deferral, just live without it.
1183 ret = mmc_gpiod_request_cd(mmc, "cd", 0, false, 0, NULL);
1184 if (ret == -EPROBE_DEFER)
1187 mmc->caps |= MMC_CAP_4_BIT_DATA | pdata->capabilities;
1188 mmc->caps2 |= pdata->capabilities2;
1189 mmc->max_segs = pdata->max_segs ? : 32;
1190 mmc->max_blk_size = TMIO_MAX_BLK_SIZE;
1191 mmc->max_blk_count = pdata->max_blk_count ? :
1192 (PAGE_SIZE / mmc->max_blk_size) * mmc->max_segs;
1193 mmc->max_req_size = min_t(size_t,
1194 mmc->max_blk_size * mmc->max_blk_count,
1195 dma_max_mapping_size(&pdev->dev));
1196 mmc->max_seg_size = mmc->max_req_size;
1198 if (mmc_can_gpio_ro(mmc))
1199 _host->ops.get_ro = mmc_gpio_get_ro;
1201 if (mmc_can_gpio_cd(mmc))
1202 _host->ops.get_cd = mmc_gpio_get_cd;
1204 _host->native_hotplug = !(mmc_can_gpio_cd(mmc) ||
1205 mmc->caps & MMC_CAP_NEEDS_POLL ||
1206 !mmc_card_is_removable(mmc));
1209 _host->reset = tmio_mmc_reset;
1212 * On Gen2+, eMMC with NONREMOVABLE currently fails because native
1213 * hotplug gets disabled. It seems RuntimePM related yet we need further
1214 * research. Since we are planning a PM overhaul anyway, let's enforce
1215 * for now the device being active by enabling native hotplug always.
1217 if (pdata->flags & TMIO_MMC_MIN_RCAR2)
1218 _host->native_hotplug = true;
1221 * While using internal tmio hardware logic for card detection, we need
1222 * to ensure it stays powered for it to work.
1224 if (_host->native_hotplug)
1225 pm_runtime_get_noresume(&pdev->dev);
1227 _host->sdio_irq_enabled = false;
1228 if (pdata->flags & TMIO_MMC_SDIO_IRQ)
1229 _host->sdio_irq_mask = TMIO_SDIO_MASK_ALL;
1231 _host->set_clock(_host, 0);
1232 tmio_mmc_hw_reset(mmc);
1234 _host->sdcard_irq_mask = sd_ctrl_read16_and_16_as_32(_host, CTL_IRQ_MASK);
1235 tmio_mmc_disable_mmc_irqs(_host, TMIO_MASK_ALL);
1237 if (_host->native_hotplug)
1238 tmio_mmc_enable_mmc_irqs(_host,
1239 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT);
1241 spin_lock_init(&_host->lock);
1242 mutex_init(&_host->ios_lock);
1244 /* Init delayed work for request timeouts */
1245 INIT_DELAYED_WORK(&_host->delayed_reset_work, tmio_mmc_reset_work);
1246 INIT_WORK(&_host->done, tmio_mmc_done_work);
1248 /* See if we also get DMA */
1249 tmio_mmc_request_dma(_host, pdata);
1251 pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
1252 pm_runtime_use_autosuspend(&pdev->dev);
1253 pm_runtime_enable(&pdev->dev);
1254 pm_runtime_get_sync(&pdev->dev);
1256 ret = mmc_add_host(mmc);
1260 dev_pm_qos_expose_latency_limit(&pdev->dev, 100);
1261 pm_runtime_put(&pdev->dev);
1266 pm_runtime_put_noidle(&pdev->dev);
1267 tmio_mmc_host_remove(_host);
1270 EXPORT_SYMBOL_GPL(tmio_mmc_host_probe);
1272 void tmio_mmc_host_remove(struct tmio_mmc_host *host)
1274 struct platform_device *pdev = host->pdev;
1275 struct mmc_host *mmc = host->mmc;
1277 pm_runtime_get_sync(&pdev->dev);
1279 if (host->pdata->flags & TMIO_MMC_SDIO_IRQ)
1280 sd_ctrl_write16(host, CTL_TRANSACTION_CTL, 0x0000);
1282 dev_pm_qos_hide_latency_limit(&pdev->dev);
1284 mmc_remove_host(mmc);
1285 cancel_work_sync(&host->done);
1286 cancel_delayed_work_sync(&host->delayed_reset_work);
1287 tmio_mmc_release_dma(host);
1289 pm_runtime_dont_use_autosuspend(&pdev->dev);
1290 if (host->native_hotplug)
1291 pm_runtime_put_noidle(&pdev->dev);
1292 pm_runtime_put_sync(&pdev->dev);
1293 pm_runtime_disable(&pdev->dev);
1295 EXPORT_SYMBOL_GPL(tmio_mmc_host_remove);
1298 static int tmio_mmc_clk_enable(struct tmio_mmc_host *host)
1300 if (!host->clk_enable)
1303 return host->clk_enable(host);
1306 static void tmio_mmc_clk_disable(struct tmio_mmc_host *host)
1308 if (host->clk_disable)
1309 host->clk_disable(host);
1312 int tmio_mmc_host_runtime_suspend(struct device *dev)
1314 struct tmio_mmc_host *host = dev_get_drvdata(dev);
1316 tmio_mmc_disable_mmc_irqs(host, TMIO_MASK_ALL);
1318 if (host->clk_cache)
1319 host->set_clock(host, 0);
1321 tmio_mmc_clk_disable(host);
1325 EXPORT_SYMBOL_GPL(tmio_mmc_host_runtime_suspend);
1327 static bool tmio_mmc_can_retune(struct tmio_mmc_host *host)
1329 return host->tap_num && mmc_can_retune(host->mmc);
1332 int tmio_mmc_host_runtime_resume(struct device *dev)
1334 struct tmio_mmc_host *host = dev_get_drvdata(dev);
1336 if (!host->runtime_synced) {
1337 host->runtime_synced = true;
1341 tmio_mmc_clk_enable(host);
1342 tmio_mmc_hw_reset(host->mmc);
1344 if (host->clk_cache)
1345 host->set_clock(host, host->clk_cache);
1347 if (host->native_hotplug)
1348 tmio_mmc_enable_mmc_irqs(host,
1349 TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT);
1351 tmio_mmc_enable_dma(host, true);
1353 if (tmio_mmc_can_retune(host) && host->select_tuning(host))
1354 dev_warn(&host->pdev->dev, "Tuning selection failed\n");
1358 EXPORT_SYMBOL_GPL(tmio_mmc_host_runtime_resume);
1361 MODULE_LICENSE("GPL v2");