2 * Driver for the MMC / SD / SDIO IP found in:
4 * TC6393XB, TC6391XB, TC6387XB, T7L66XB, ASIC3, SH-Mobile SoCs
6 * Copyright (C) 2015-17 Renesas Electronics Corporation
7 * Copyright (C) 2016-17 Sang Engineering, Wolfram Sang
8 * Copyright (C) 2017 Horms Solutions, Simon Horman
9 * Copyright (C) 2011 Guennadi Liakhovetski
10 * Copyright (C) 2007 Ian Molton
11 * Copyright (C) 2004 Ian Molton
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
17 * This driver draws mainly on scattered spec sheets, Reverse engineering
18 * of the toshiba e800 SD driver and some parts of the 2.4 ASIC3 driver (4 bit
19 * support). (Further 4 bit support from a later datasheet).
22 * Investigate using a workqueue for PIO transfers
24 * Better Power management
25 * Handle MMC errors better
26 * double buffer support
30 #include <linux/delay.h>
31 #include <linux/device.h>
32 #include <linux/highmem.h>
33 #include <linux/interrupt.h>
35 #include <linux/irq.h>
36 #include <linux/mfd/tmio.h>
37 #include <linux/mmc/card.h>
38 #include <linux/mmc/host.h>
39 #include <linux/mmc/mmc.h>
40 #include <linux/mmc/slot-gpio.h>
41 #include <linux/module.h>
42 #include <linux/pagemap.h>
43 #include <linux/platform_device.h>
44 #include <linux/pm_qos.h>
45 #include <linux/pm_runtime.h>
46 #include <linux/regulator/consumer.h>
47 #include <linux/mmc/sdio.h>
48 #include <linux/scatterlist.h>
49 #include <linux/spinlock.h>
50 #include <linux/swiotlb.h>
51 #include <linux/workqueue.h>
55 static inline void tmio_mmc_start_dma(struct tmio_mmc_host
*host
,
56 struct mmc_data
*data
)
59 host
->dma_ops
->start(host
, data
);
62 static inline void tmio_mmc_enable_dma(struct tmio_mmc_host
*host
, bool enable
)
65 host
->dma_ops
->enable(host
, enable
);
68 static inline void tmio_mmc_request_dma(struct tmio_mmc_host
*host
,
69 struct tmio_mmc_data
*pdata
)
72 host
->dma_ops
->request(host
, pdata
);
79 static inline void tmio_mmc_release_dma(struct tmio_mmc_host
*host
)
82 host
->dma_ops
->release(host
);
85 static inline void tmio_mmc_abort_dma(struct tmio_mmc_host
*host
)
88 host
->dma_ops
->abort(host
);
91 static inline void tmio_mmc_dataend_dma(struct tmio_mmc_host
*host
)
94 host
->dma_ops
->dataend(host
);
97 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host
*host
, u32 i
)
99 host
->sdcard_irq_mask
&= ~(i
& TMIO_MASK_IRQ
);
100 sd_ctrl_write32_as_16_and_16(host
, CTL_IRQ_MASK
, host
->sdcard_irq_mask
);
102 EXPORT_SYMBOL_GPL(tmio_mmc_enable_mmc_irqs
);
104 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host
*host
, u32 i
)
106 host
->sdcard_irq_mask
|= (i
& TMIO_MASK_IRQ
);
107 sd_ctrl_write32_as_16_and_16(host
, CTL_IRQ_MASK
, host
->sdcard_irq_mask
);
109 EXPORT_SYMBOL_GPL(tmio_mmc_disable_mmc_irqs
);
111 static void tmio_mmc_ack_mmc_irqs(struct tmio_mmc_host
*host
, u32 i
)
113 sd_ctrl_write32_as_16_and_16(host
, CTL_STATUS
, ~i
);
116 static void tmio_mmc_init_sg(struct tmio_mmc_host
*host
, struct mmc_data
*data
)
118 host
->sg_len
= data
->sg_len
;
119 host
->sg_ptr
= data
->sg
;
120 host
->sg_orig
= data
->sg
;
124 static int tmio_mmc_next_sg(struct tmio_mmc_host
*host
)
126 host
->sg_ptr
= sg_next(host
->sg_ptr
);
128 return --host
->sg_len
;
131 #define CMDREQ_TIMEOUT 5000
133 static void tmio_mmc_enable_sdio_irq(struct mmc_host
*mmc
, int enable
)
135 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
137 if (enable
&& !host
->sdio_irq_enabled
) {
140 /* Keep device active while SDIO irq is enabled */
141 pm_runtime_get_sync(mmc_dev(mmc
));
143 host
->sdio_irq_enabled
= true;
144 host
->sdio_irq_mask
= TMIO_SDIO_MASK_ALL
& ~TMIO_SDIO_STAT_IOIRQ
;
146 /* Clear obsolete interrupts before enabling */
147 sdio_status
= sd_ctrl_read16(host
, CTL_SDIO_STATUS
) & ~TMIO_SDIO_MASK_ALL
;
148 if (host
->pdata
->flags
& TMIO_MMC_SDIO_STATUS_SETBITS
)
149 sdio_status
|= TMIO_SDIO_SETBITS_MASK
;
150 sd_ctrl_write16(host
, CTL_SDIO_STATUS
, sdio_status
);
152 sd_ctrl_write16(host
, CTL_SDIO_IRQ_MASK
, host
->sdio_irq_mask
);
153 } else if (!enable
&& host
->sdio_irq_enabled
) {
154 host
->sdio_irq_mask
= TMIO_SDIO_MASK_ALL
;
155 sd_ctrl_write16(host
, CTL_SDIO_IRQ_MASK
, host
->sdio_irq_mask
);
157 host
->sdio_irq_enabled
= false;
158 pm_runtime_mark_last_busy(mmc_dev(mmc
));
159 pm_runtime_put_autosuspend(mmc_dev(mmc
));
163 static void tmio_mmc_clk_start(struct tmio_mmc_host
*host
)
165 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, CLK_CTL_SCLKEN
|
166 sd_ctrl_read16(host
, CTL_SD_CARD_CLK_CTL
));
168 /* HW engineers overrode docs: no sleep needed on R-Car2+ */
169 if (!(host
->pdata
->flags
& TMIO_MMC_MIN_RCAR2
))
170 usleep_range(10000, 11000);
172 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
) {
173 sd_ctrl_write16(host
, CTL_CLK_AND_WAIT_CTL
, 0x0100);
174 usleep_range(10000, 11000);
178 static void tmio_mmc_clk_stop(struct tmio_mmc_host
*host
)
180 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
) {
181 sd_ctrl_write16(host
, CTL_CLK_AND_WAIT_CTL
, 0x0000);
182 usleep_range(10000, 11000);
185 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, ~CLK_CTL_SCLKEN
&
186 sd_ctrl_read16(host
, CTL_SD_CARD_CLK_CTL
));
188 /* HW engineers overrode docs: no sleep needed on R-Car2+ */
189 if (!(host
->pdata
->flags
& TMIO_MMC_MIN_RCAR2
))
190 usleep_range(10000, 11000);
193 static void tmio_mmc_set_clock(struct tmio_mmc_host
*host
,
194 unsigned int new_clock
)
198 if (new_clock
== 0) {
199 tmio_mmc_clk_stop(host
);
203 if (host
->clk_update
)
204 clock
= host
->clk_update(host
, new_clock
) / 512;
206 clock
= host
->mmc
->f_min
;
208 for (clk
= 0x80000080; new_clock
>= (clock
<< 1); clk
>>= 1)
211 /* 1/1 clock is option */
212 if ((host
->pdata
->flags
& TMIO_MMC_CLK_ACTUAL
) && ((clk
>> 22) & 0x1))
215 if (host
->set_clk_div
)
216 host
->set_clk_div(host
->pdev
, (clk
>> 22) & 1);
218 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, ~CLK_CTL_SCLKEN
&
219 sd_ctrl_read16(host
, CTL_SD_CARD_CLK_CTL
));
220 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, clk
& CLK_CTL_DIV_MASK
);
221 if (!(host
->pdata
->flags
& TMIO_MMC_MIN_RCAR2
))
222 usleep_range(10000, 11000);
224 tmio_mmc_clk_start(host
);
227 static void tmio_mmc_reset(struct tmio_mmc_host
*host
)
229 /* FIXME - should we set stop clock reg here */
230 sd_ctrl_write16(host
, CTL_RESET_SD
, 0x0000);
231 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
)
232 sd_ctrl_write16(host
, CTL_RESET_SDIO
, 0x0000);
233 usleep_range(10000, 11000);
234 sd_ctrl_write16(host
, CTL_RESET_SD
, 0x0001);
235 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
)
236 sd_ctrl_write16(host
, CTL_RESET_SDIO
, 0x0001);
237 usleep_range(10000, 11000);
239 if (host
->pdata
->flags
& TMIO_MMC_SDIO_IRQ
) {
240 sd_ctrl_write16(host
, CTL_SDIO_IRQ_MASK
, host
->sdio_irq_mask
);
241 sd_ctrl_write16(host
, CTL_TRANSACTION_CTL
, 0x0001);
246 static void tmio_mmc_reset_work(struct work_struct
*work
)
248 struct tmio_mmc_host
*host
= container_of(work
, struct tmio_mmc_host
,
249 delayed_reset_work
.work
);
250 struct mmc_request
*mrq
;
253 spin_lock_irqsave(&host
->lock
, flags
);
257 * is request already finished? Since we use a non-blocking
258 * cancel_delayed_work(), it can happen, that a .set_ios() call preempts
259 * us, so, have to check for IS_ERR(host->mrq)
261 if (IS_ERR_OR_NULL(mrq
) ||
262 time_is_after_jiffies(host
->last_req_ts
+
263 msecs_to_jiffies(CMDREQ_TIMEOUT
))) {
264 spin_unlock_irqrestore(&host
->lock
, flags
);
268 dev_warn(&host
->pdev
->dev
,
269 "timeout waiting for hardware interrupt (CMD%u)\n",
273 host
->data
->error
= -ETIMEDOUT
;
275 host
->cmd
->error
= -ETIMEDOUT
;
277 mrq
->cmd
->error
= -ETIMEDOUT
;
282 spin_unlock_irqrestore(&host
->lock
, flags
);
284 tmio_mmc_reset(host
);
286 /* Ready for new calls */
289 tmio_mmc_abort_dma(host
);
290 mmc_request_done(host
->mmc
, mrq
);
293 /* These are the bitmasks the tmio chip requires to implement the MMC response
294 * types. Note that R1 and R6 are the same in this scheme. */
295 #define APP_CMD 0x0040
296 #define RESP_NONE 0x0300
297 #define RESP_R1 0x0400
298 #define RESP_R1B 0x0500
299 #define RESP_R2 0x0600
300 #define RESP_R3 0x0700
301 #define DATA_PRESENT 0x0800
302 #define TRANSFER_READ 0x1000
303 #define TRANSFER_MULTI 0x2000
304 #define SECURITY_CMD 0x4000
305 #define NO_CMD12_ISSUE 0x4000 /* TMIO_MMC_HAVE_CMD12_CTRL */
307 static int tmio_mmc_start_command(struct tmio_mmc_host
*host
,
308 struct mmc_command
*cmd
)
310 struct mmc_data
*data
= host
->data
;
312 u32 irq_mask
= TMIO_MASK_CMD
;
314 switch (mmc_resp_type(cmd
)) {
315 case MMC_RSP_NONE
: c
|= RESP_NONE
; break;
317 case MMC_RSP_R1_NO_CRC
:
319 case MMC_RSP_R1B
: c
|= RESP_R1B
; break;
320 case MMC_RSP_R2
: c
|= RESP_R2
; break;
321 case MMC_RSP_R3
: c
|= RESP_R3
; break;
323 pr_debug("Unknown response type %d\n", mmc_resp_type(cmd
));
329 /* FIXME - this seems to be ok commented out but the spec suggest this bit
330 * should be set when issuing app commands.
331 * if(cmd->flags & MMC_FLAG_ACMD)
336 if (data
->blocks
> 1) {
337 sd_ctrl_write16(host
, CTL_STOP_INTERNAL_ACTION
, TMIO_STOP_SEC
);
341 * Disable auto CMD12 at IO_RW_EXTENDED and
342 * SET_BLOCK_COUNT when doing multiple block transfer
344 if ((host
->pdata
->flags
& TMIO_MMC_HAVE_CMD12_CTRL
) &&
345 (cmd
->opcode
== SD_IO_RW_EXTENDED
|| host
->mrq
->sbc
))
348 if (data
->flags
& MMC_DATA_READ
)
352 tmio_mmc_enable_mmc_irqs(host
, irq_mask
);
354 /* Fire off the command */
355 sd_ctrl_write32_as_16_and_16(host
, CTL_ARG_REG
, cmd
->arg
);
356 sd_ctrl_write16(host
, CTL_SD_CMD
, c
);
361 static void tmio_mmc_transfer_data(struct tmio_mmc_host
*host
,
365 int is_read
= host
->data
->flags
& MMC_DATA_READ
;
371 if (host
->pdata
->flags
& TMIO_MMC_32BIT_DATA_PORT
) {
373 u32
*buf32
= (u32
*)buf
;
376 sd_ctrl_read32_rep(host
, CTL_SD_DATA_PORT
, buf32
,
379 sd_ctrl_write32_rep(host
, CTL_SD_DATA_PORT
, buf32
,
382 /* if count was multiple of 4 */
390 sd_ctrl_read32_rep(host
, CTL_SD_DATA_PORT
, &data
, 1);
391 memcpy(buf32
, &data
, count
);
393 memcpy(&data
, buf32
, count
);
394 sd_ctrl_write32_rep(host
, CTL_SD_DATA_PORT
, &data
, 1);
401 sd_ctrl_read16_rep(host
, CTL_SD_DATA_PORT
, buf
, count
>> 1);
403 sd_ctrl_write16_rep(host
, CTL_SD_DATA_PORT
, buf
, count
>> 1);
405 /* if count was even number */
409 /* if count was odd number */
410 buf8
= (u8
*)(buf
+ (count
>> 1));
415 * driver and this function are assuming that
416 * it is used as little endian
419 *buf8
= sd_ctrl_read16(host
, CTL_SD_DATA_PORT
) & 0xff;
421 sd_ctrl_write16(host
, CTL_SD_DATA_PORT
, *buf8
);
425 * This chip always returns (at least?) as much data as you ask for.
426 * I'm unsure what happens if you ask for less than a block. This should be
427 * looked into to ensure that a funny length read doesn't hose the controller.
429 static void tmio_mmc_pio_irq(struct tmio_mmc_host
*host
)
431 struct mmc_data
*data
= host
->data
;
437 if ((host
->chan_tx
|| host
->chan_rx
) && !host
->force_pio
) {
438 pr_err("PIO IRQ in DMA mode!\n");
441 pr_debug("Spurious PIO IRQ\n");
445 sg_virt
= tmio_mmc_kmap_atomic(host
->sg_ptr
, &flags
);
446 buf
= (unsigned short *)(sg_virt
+ host
->sg_off
);
448 count
= host
->sg_ptr
->length
- host
->sg_off
;
449 if (count
> data
->blksz
)
452 pr_debug("count: %08x offset: %08x flags %08x\n",
453 count
, host
->sg_off
, data
->flags
);
455 /* Transfer the data */
456 tmio_mmc_transfer_data(host
, buf
, count
);
458 host
->sg_off
+= count
;
460 tmio_mmc_kunmap_atomic(host
->sg_ptr
, &flags
, sg_virt
);
462 if (host
->sg_off
== host
->sg_ptr
->length
)
463 tmio_mmc_next_sg(host
);
466 static void tmio_mmc_check_bounce_buffer(struct tmio_mmc_host
*host
)
468 if (host
->sg_ptr
== &host
->bounce_sg
) {
470 void *sg_vaddr
= tmio_mmc_kmap_atomic(host
->sg_orig
, &flags
);
472 memcpy(sg_vaddr
, host
->bounce_buf
, host
->bounce_sg
.length
);
473 tmio_mmc_kunmap_atomic(host
->sg_orig
, &flags
, sg_vaddr
);
477 /* needs to be called with host->lock held */
478 void tmio_mmc_do_data_irq(struct tmio_mmc_host
*host
)
480 struct mmc_data
*data
= host
->data
;
481 struct mmc_command
*stop
;
486 dev_warn(&host
->pdev
->dev
, "Spurious data end IRQ\n");
491 /* FIXME - return correct transfer count on errors */
493 data
->bytes_xfered
= data
->blocks
* data
->blksz
;
495 data
->bytes_xfered
= 0;
497 pr_debug("Completed data request\n");
500 * FIXME: other drivers allow an optional stop command of any given type
501 * which we dont do, as the chip can auto generate them.
502 * Perhaps we can be smarter about when to use auto CMD12 and
503 * only issue the auto request when we know this is the desired
504 * stop command, allowing fallback to the stop command the
505 * upper layers expect. For now, we do what works.
508 if (data
->flags
& MMC_DATA_READ
) {
509 if (host
->chan_rx
&& !host
->force_pio
)
510 tmio_mmc_check_bounce_buffer(host
);
511 dev_dbg(&host
->pdev
->dev
, "Complete Rx request %p\n",
514 dev_dbg(&host
->pdev
->dev
, "Complete Tx request %p\n",
518 if (stop
&& !host
->mrq
->sbc
) {
519 if (stop
->opcode
!= MMC_STOP_TRANSMISSION
|| stop
->arg
)
520 dev_err(&host
->pdev
->dev
, "unsupported stop: CMD%u,0x%x. We did CMD12,0\n",
521 stop
->opcode
, stop
->arg
);
523 /* fill in response from auto CMD12 */
524 stop
->resp
[0] = sd_ctrl_read16_and_16_as_32(host
, CTL_RESPONSE
);
526 sd_ctrl_write16(host
, CTL_STOP_INTERNAL_ACTION
, 0);
529 schedule_work(&host
->done
);
531 EXPORT_SYMBOL_GPL(tmio_mmc_do_data_irq
);
533 static void tmio_mmc_data_irq(struct tmio_mmc_host
*host
, unsigned int stat
)
535 struct mmc_data
*data
;
537 spin_lock(&host
->lock
);
543 if (stat
& TMIO_STAT_CRCFAIL
|| stat
& TMIO_STAT_STOPBIT_ERR
||
544 stat
& TMIO_STAT_TXUNDERRUN
)
545 data
->error
= -EILSEQ
;
546 if (host
->chan_tx
&& (data
->flags
& MMC_DATA_WRITE
) && !host
->force_pio
) {
547 u32 status
= sd_ctrl_read16_and_16_as_32(host
, CTL_STATUS
);
551 * Has all data been written out yet? Testing on SuperH showed,
552 * that in most cases the first interrupt comes already with the
553 * BUSY status bit clear, but on some operations, like mount or
554 * in the beginning of a write / sync / umount, there is one
555 * DATAEND interrupt with the BUSY bit set, in this cases
556 * waiting for one more interrupt fixes the problem.
558 if (host
->pdata
->flags
& TMIO_MMC_HAS_IDLE_WAIT
) {
559 if (status
& TMIO_STAT_SCLKDIVEN
)
562 if (!(status
& TMIO_STAT_CMD_BUSY
))
567 tmio_mmc_disable_mmc_irqs(host
, TMIO_STAT_DATAEND
);
568 tmio_mmc_dataend_dma(host
);
570 } else if (host
->chan_rx
&& (data
->flags
& MMC_DATA_READ
) && !host
->force_pio
) {
571 tmio_mmc_disable_mmc_irqs(host
, TMIO_STAT_DATAEND
);
572 tmio_mmc_dataend_dma(host
);
574 tmio_mmc_do_data_irq(host
);
575 tmio_mmc_disable_mmc_irqs(host
, TMIO_MASK_READOP
| TMIO_MASK_WRITEOP
);
578 spin_unlock(&host
->lock
);
581 static void tmio_mmc_cmd_irq(struct tmio_mmc_host
*host
, unsigned int stat
)
583 struct mmc_command
*cmd
= host
->cmd
;
586 spin_lock(&host
->lock
);
589 pr_debug("Spurious CMD irq\n");
593 /* This controller is sicker than the PXA one. Not only do we need to
594 * drop the top 8 bits of the first response word, we also need to
595 * modify the order of the response for short response command types.
598 for (i
= 3, addr
= CTL_RESPONSE
; i
>= 0 ; i
--, addr
+= 4)
599 cmd
->resp
[i
] = sd_ctrl_read16_and_16_as_32(host
, addr
);
601 if (cmd
->flags
& MMC_RSP_136
) {
602 cmd
->resp
[0] = (cmd
->resp
[0] << 8) | (cmd
->resp
[1] >> 24);
603 cmd
->resp
[1] = (cmd
->resp
[1] << 8) | (cmd
->resp
[2] >> 24);
604 cmd
->resp
[2] = (cmd
->resp
[2] << 8) | (cmd
->resp
[3] >> 24);
606 } else if (cmd
->flags
& MMC_RSP_R3
) {
607 cmd
->resp
[0] = cmd
->resp
[3];
610 if (stat
& TMIO_STAT_CMDTIMEOUT
)
611 cmd
->error
= -ETIMEDOUT
;
612 else if ((stat
& TMIO_STAT_CRCFAIL
&& cmd
->flags
& MMC_RSP_CRC
) ||
613 stat
& TMIO_STAT_STOPBIT_ERR
||
614 stat
& TMIO_STAT_CMD_IDX_ERR
)
615 cmd
->error
= -EILSEQ
;
617 /* If there is data to handle we enable data IRQs here, and
618 * we will ultimatley finish the request in the data_end handler.
619 * If theres no data or we encountered an error, finish now.
621 if (host
->data
&& (!cmd
->error
|| cmd
->error
== -EILSEQ
)) {
622 if (host
->data
->flags
& MMC_DATA_READ
) {
623 if (host
->force_pio
|| !host
->chan_rx
) {
624 tmio_mmc_enable_mmc_irqs(host
, TMIO_MASK_READOP
);
626 tmio_mmc_disable_mmc_irqs(host
,
628 tasklet_schedule(&host
->dma_issue
);
631 if (host
->force_pio
|| !host
->chan_tx
) {
632 tmio_mmc_enable_mmc_irqs(host
, TMIO_MASK_WRITEOP
);
634 tmio_mmc_disable_mmc_irqs(host
,
636 tasklet_schedule(&host
->dma_issue
);
640 schedule_work(&host
->done
);
644 spin_unlock(&host
->lock
);
647 static bool __tmio_mmc_card_detect_irq(struct tmio_mmc_host
*host
,
648 int ireg
, int status
)
650 struct mmc_host
*mmc
= host
->mmc
;
652 /* Card insert / remove attempts */
653 if (ireg
& (TMIO_STAT_CARD_INSERT
| TMIO_STAT_CARD_REMOVE
)) {
654 tmio_mmc_ack_mmc_irqs(host
, TMIO_STAT_CARD_INSERT
|
655 TMIO_STAT_CARD_REMOVE
);
656 if ((((ireg
& TMIO_STAT_CARD_REMOVE
) && mmc
->card
) ||
657 ((ireg
& TMIO_STAT_CARD_INSERT
) && !mmc
->card
)) &&
658 !work_pending(&mmc
->detect
.work
))
659 mmc_detect_change(host
->mmc
, msecs_to_jiffies(100));
666 static bool __tmio_mmc_sdcard_irq(struct tmio_mmc_host
*host
, int ireg
,
669 /* Command completion */
670 if (ireg
& (TMIO_STAT_CMDRESPEND
| TMIO_STAT_CMDTIMEOUT
)) {
671 tmio_mmc_ack_mmc_irqs(host
, TMIO_STAT_CMDRESPEND
|
672 TMIO_STAT_CMDTIMEOUT
);
673 tmio_mmc_cmd_irq(host
, status
);
678 if (ireg
& (TMIO_STAT_RXRDY
| TMIO_STAT_TXRQ
)) {
679 tmio_mmc_ack_mmc_irqs(host
, TMIO_STAT_RXRDY
| TMIO_STAT_TXRQ
);
680 tmio_mmc_pio_irq(host
);
684 /* Data transfer completion */
685 if (ireg
& TMIO_STAT_DATAEND
) {
686 tmio_mmc_ack_mmc_irqs(host
, TMIO_STAT_DATAEND
);
687 tmio_mmc_data_irq(host
, status
);
694 static void __tmio_mmc_sdio_irq(struct tmio_mmc_host
*host
)
696 struct mmc_host
*mmc
= host
->mmc
;
697 struct tmio_mmc_data
*pdata
= host
->pdata
;
698 unsigned int ireg
, status
;
699 unsigned int sdio_status
;
701 if (!(pdata
->flags
& TMIO_MMC_SDIO_IRQ
))
704 status
= sd_ctrl_read16(host
, CTL_SDIO_STATUS
);
705 ireg
= status
& TMIO_SDIO_MASK_ALL
& ~host
->sdio_irq_mask
;
707 sdio_status
= status
& ~TMIO_SDIO_MASK_ALL
;
708 if (pdata
->flags
& TMIO_MMC_SDIO_STATUS_SETBITS
)
709 sdio_status
|= TMIO_SDIO_SETBITS_MASK
;
711 sd_ctrl_write16(host
, CTL_SDIO_STATUS
, sdio_status
);
713 if (mmc
->caps
& MMC_CAP_SDIO_IRQ
&& ireg
& TMIO_SDIO_STAT_IOIRQ
)
714 mmc_signal_sdio_irq(mmc
);
717 irqreturn_t
tmio_mmc_irq(int irq
, void *devid
)
719 struct tmio_mmc_host
*host
= devid
;
720 unsigned int ireg
, status
;
722 status
= sd_ctrl_read16_and_16_as_32(host
, CTL_STATUS
);
723 ireg
= status
& TMIO_MASK_IRQ
& ~host
->sdcard_irq_mask
;
725 /* Clear the status except the interrupt status */
726 sd_ctrl_write32_as_16_and_16(host
, CTL_STATUS
, TMIO_MASK_IRQ
);
728 if (__tmio_mmc_card_detect_irq(host
, ireg
, status
))
730 if (__tmio_mmc_sdcard_irq(host
, ireg
, status
))
733 __tmio_mmc_sdio_irq(host
);
737 EXPORT_SYMBOL_GPL(tmio_mmc_irq
);
739 static int tmio_mmc_start_data(struct tmio_mmc_host
*host
,
740 struct mmc_data
*data
)
742 struct tmio_mmc_data
*pdata
= host
->pdata
;
744 pr_debug("setup data transfer: blocksize %08x nr_blocks %d\n",
745 data
->blksz
, data
->blocks
);
747 /* Some hardware cannot perform 2 byte requests in 4/8 bit mode */
748 if (host
->mmc
->ios
.bus_width
== MMC_BUS_WIDTH_4
||
749 host
->mmc
->ios
.bus_width
== MMC_BUS_WIDTH_8
) {
750 int blksz_2bytes
= pdata
->flags
& TMIO_MMC_BLKSZ_2BYTES
;
752 if (data
->blksz
< 2 || (data
->blksz
< 4 && !blksz_2bytes
)) {
753 pr_err("%s: %d byte block unsupported in 4/8 bit mode\n",
754 mmc_hostname(host
->mmc
), data
->blksz
);
759 tmio_mmc_init_sg(host
, data
);
761 host
->force_pio
= false;
763 /* Set transfer length / blocksize */
764 sd_ctrl_write16(host
, CTL_SD_XFER_LEN
, data
->blksz
);
765 sd_ctrl_write16(host
, CTL_XFER_BLK_COUNT
, data
->blocks
);
767 tmio_mmc_start_dma(host
, data
);
772 static void tmio_mmc_hw_reset(struct mmc_host
*mmc
)
774 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
777 host
->hw_reset(host
);
780 static int tmio_mmc_execute_tuning(struct mmc_host
*mmc
, u32 opcode
)
782 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
785 if (!host
->init_tuning
|| !host
->select_tuning
)
786 /* Tuning is not supported */
789 host
->tap_num
= host
->init_tuning(host
);
791 /* Tuning is not supported */
794 if (host
->tap_num
* 2 >= sizeof(host
->taps
) * BITS_PER_BYTE
) {
795 dev_warn_once(&host
->pdev
->dev
,
796 "Too many taps, skipping tuning. Please consider updating size of taps field of tmio_mmc_host\n");
800 bitmap_zero(host
->taps
, host
->tap_num
* 2);
802 /* Issue CMD19 twice for each tap */
803 for (i
= 0; i
< 2 * host
->tap_num
; i
++) {
804 if (host
->prepare_tuning
)
805 host
->prepare_tuning(host
, i
% host
->tap_num
);
807 ret
= mmc_send_tuning(mmc
, opcode
, NULL
);
808 if (ret
&& ret
!= -EILSEQ
)
811 set_bit(i
, host
->taps
);
813 usleep_range(1000, 1200);
816 ret
= host
->select_tuning(host
);
820 dev_warn(&host
->pdev
->dev
, "Tuning procedure failed\n");
821 tmio_mmc_hw_reset(mmc
);
827 static void tmio_process_mrq(struct tmio_mmc_host
*host
,
828 struct mmc_request
*mrq
)
830 struct mmc_command
*cmd
;
833 if (mrq
->sbc
&& host
->cmd
!= mrq
->sbc
) {
838 ret
= tmio_mmc_start_data(host
, mrq
->data
);
844 ret
= tmio_mmc_start_command(host
, cmd
);
848 schedule_delayed_work(&host
->delayed_reset_work
,
849 msecs_to_jiffies(CMDREQ_TIMEOUT
));
854 mrq
->cmd
->error
= ret
;
855 mmc_request_done(host
->mmc
, mrq
);
858 /* Process requests from the MMC layer */
859 static void tmio_mmc_request(struct mmc_host
*mmc
, struct mmc_request
*mrq
)
861 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
864 spin_lock_irqsave(&host
->lock
, flags
);
867 pr_debug("request not null\n");
868 if (IS_ERR(host
->mrq
)) {
869 spin_unlock_irqrestore(&host
->lock
, flags
);
870 mrq
->cmd
->error
= -EAGAIN
;
871 mmc_request_done(mmc
, mrq
);
876 host
->last_req_ts
= jiffies
;
880 spin_unlock_irqrestore(&host
->lock
, flags
);
882 tmio_process_mrq(host
, mrq
);
885 static void tmio_mmc_finish_request(struct tmio_mmc_host
*host
)
887 struct mmc_request
*mrq
;
890 spin_lock_irqsave(&host
->lock
, flags
);
893 if (IS_ERR_OR_NULL(mrq
)) {
894 spin_unlock_irqrestore(&host
->lock
, flags
);
898 /* If not SET_BLOCK_COUNT, clear old data */
899 if (host
->cmd
!= mrq
->sbc
) {
905 cancel_delayed_work(&host
->delayed_reset_work
);
907 spin_unlock_irqrestore(&host
->lock
, flags
);
909 if (mrq
->cmd
->error
|| (mrq
->data
&& mrq
->data
->error
))
910 tmio_mmc_abort_dma(host
);
912 if (host
->check_scc_error
)
913 host
->check_scc_error(host
);
915 /* If SET_BLOCK_COUNT, continue with main command */
916 if (host
->mrq
&& !mrq
->cmd
->error
) {
917 tmio_process_mrq(host
, mrq
);
921 mmc_request_done(host
->mmc
, mrq
);
924 static void tmio_mmc_done_work(struct work_struct
*work
)
926 struct tmio_mmc_host
*host
= container_of(work
, struct tmio_mmc_host
,
928 tmio_mmc_finish_request(host
);
931 static void tmio_mmc_power_on(struct tmio_mmc_host
*host
, unsigned short vdd
)
933 struct mmc_host
*mmc
= host
->mmc
;
936 /* .set_ios() is returning void, so, no chance to report an error */
939 host
->set_pwr(host
->pdev
, 1);
941 if (!IS_ERR(mmc
->supply
.vmmc
)) {
942 ret
= mmc_regulator_set_ocr(mmc
, mmc
->supply
.vmmc
, vdd
);
944 * Attention: empiric value. With a b43 WiFi SDIO card this
945 * delay proved necessary for reliable card-insertion probing.
946 * 100us were not enough. Is this the same 140us delay, as in
947 * tmio_mmc_set_ios()?
949 usleep_range(200, 300);
952 * It seems, VccQ should be switched on after Vcc, this is also what the
953 * omap_hsmmc.c driver does.
955 if (!IS_ERR(mmc
->supply
.vqmmc
) && !ret
) {
956 ret
= regulator_enable(mmc
->supply
.vqmmc
);
957 usleep_range(200, 300);
961 dev_dbg(&host
->pdev
->dev
, "Regulators failed to power up: %d\n",
965 static void tmio_mmc_power_off(struct tmio_mmc_host
*host
)
967 struct mmc_host
*mmc
= host
->mmc
;
969 if (!IS_ERR(mmc
->supply
.vqmmc
))
970 regulator_disable(mmc
->supply
.vqmmc
);
972 if (!IS_ERR(mmc
->supply
.vmmc
))
973 mmc_regulator_set_ocr(mmc
, mmc
->supply
.vmmc
, 0);
976 host
->set_pwr(host
->pdev
, 0);
979 static void tmio_mmc_set_bus_width(struct tmio_mmc_host
*host
,
980 unsigned char bus_width
)
982 u16 reg
= sd_ctrl_read16(host
, CTL_SD_MEM_CARD_OPT
)
983 & ~(CARD_OPT_WIDTH
| CARD_OPT_WIDTH8
);
985 /* reg now applies to MMC_BUS_WIDTH_4 */
986 if (bus_width
== MMC_BUS_WIDTH_1
)
987 reg
|= CARD_OPT_WIDTH
;
988 else if (bus_width
== MMC_BUS_WIDTH_8
)
989 reg
|= CARD_OPT_WIDTH8
;
991 sd_ctrl_write16(host
, CTL_SD_MEM_CARD_OPT
, reg
);
994 /* Set MMC clock / power.
995 * Note: This controller uses a simple divider scheme therefore it cannot
996 * run a MMC card at full speed (20MHz). The max clock is 24MHz on SD, but as
997 * MMC wont run that fast, it has to be clocked at 12MHz which is the next
1000 static void tmio_mmc_set_ios(struct mmc_host
*mmc
, struct mmc_ios
*ios
)
1002 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
1003 struct device
*dev
= &host
->pdev
->dev
;
1004 unsigned long flags
;
1006 mutex_lock(&host
->ios_lock
);
1008 spin_lock_irqsave(&host
->lock
, flags
);
1010 if (IS_ERR(host
->mrq
)) {
1012 "%s.%d: concurrent .set_ios(), clk %u, mode %u\n",
1013 current
->comm
, task_pid_nr(current
),
1014 ios
->clock
, ios
->power_mode
);
1015 host
->mrq
= ERR_PTR(-EINTR
);
1018 "%s.%d: CMD%u active since %lu, now %lu!\n",
1019 current
->comm
, task_pid_nr(current
),
1020 host
->mrq
->cmd
->opcode
, host
->last_req_ts
,
1023 spin_unlock_irqrestore(&host
->lock
, flags
);
1025 mutex_unlock(&host
->ios_lock
);
1029 host
->mrq
= ERR_PTR(-EBUSY
);
1031 spin_unlock_irqrestore(&host
->lock
, flags
);
1033 switch (ios
->power_mode
) {
1035 tmio_mmc_power_off(host
);
1036 tmio_mmc_clk_stop(host
);
1039 tmio_mmc_power_on(host
, ios
->vdd
);
1040 tmio_mmc_set_clock(host
, ios
->clock
);
1041 tmio_mmc_set_bus_width(host
, ios
->bus_width
);
1044 tmio_mmc_set_clock(host
, ios
->clock
);
1045 tmio_mmc_set_bus_width(host
, ios
->bus_width
);
1049 /* Let things settle. delay taken from winCE driver */
1050 usleep_range(140, 200);
1051 if (PTR_ERR(host
->mrq
) == -EINTR
)
1052 dev_dbg(&host
->pdev
->dev
,
1053 "%s.%d: IOS interrupted: clk %u, mode %u",
1054 current
->comm
, task_pid_nr(current
),
1055 ios
->clock
, ios
->power_mode
);
1058 host
->clk_cache
= ios
->clock
;
1060 mutex_unlock(&host
->ios_lock
);
1063 static int tmio_mmc_get_ro(struct mmc_host
*mmc
)
1065 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
1067 return !(sd_ctrl_read16_and_16_as_32(host
, CTL_STATUS
) &
1068 TMIO_STAT_WRPROTECT
);
1071 static int tmio_mmc_get_cd(struct mmc_host
*mmc
)
1073 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
1075 return !!(sd_ctrl_read16_and_16_as_32(host
, CTL_STATUS
) &
1076 TMIO_STAT_SIGSTATE
);
1079 static int tmio_multi_io_quirk(struct mmc_card
*card
,
1080 unsigned int direction
, int blk_size
)
1082 struct tmio_mmc_host
*host
= mmc_priv(card
->host
);
1084 if (host
->multi_io_quirk
)
1085 return host
->multi_io_quirk(card
, direction
, blk_size
);
1090 static const struct mmc_host_ops tmio_mmc_ops
= {
1091 .request
= tmio_mmc_request
,
1092 .set_ios
= tmio_mmc_set_ios
,
1093 .get_ro
= tmio_mmc_get_ro
,
1094 .get_cd
= tmio_mmc_get_cd
,
1095 .enable_sdio_irq
= tmio_mmc_enable_sdio_irq
,
1096 .multi_io_quirk
= tmio_multi_io_quirk
,
1097 .hw_reset
= tmio_mmc_hw_reset
,
1098 .execute_tuning
= tmio_mmc_execute_tuning
,
1101 static int tmio_mmc_init_ocr(struct tmio_mmc_host
*host
)
1103 struct tmio_mmc_data
*pdata
= host
->pdata
;
1104 struct mmc_host
*mmc
= host
->mmc
;
1107 err
= mmc_regulator_get_supply(mmc
);
1111 /* use ocr_mask if no regulator */
1112 if (!mmc
->ocr_avail
)
1113 mmc
->ocr_avail
= pdata
->ocr_mask
;
1117 * There is possibility that regulator has not been probed
1119 if (!mmc
->ocr_avail
)
1120 return -EPROBE_DEFER
;
1125 static void tmio_mmc_of_parse(struct platform_device
*pdev
,
1126 struct mmc_host
*mmc
)
1128 const struct device_node
*np
= pdev
->dev
.of_node
;
1135 * For new platforms, please use "disable-wp" instead of
1136 * "toshiba,mmc-wrprotect-disable"
1138 if (of_get_property(np
, "toshiba,mmc-wrprotect-disable", NULL
))
1139 mmc
->caps2
|= MMC_CAP2_NO_WRITE_PROTECT
;
1142 struct tmio_mmc_host
*tmio_mmc_host_alloc(struct platform_device
*pdev
,
1143 struct tmio_mmc_data
*pdata
)
1145 struct tmio_mmc_host
*host
;
1146 struct mmc_host
*mmc
;
1147 struct resource
*res
;
1151 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1152 ctl
= devm_ioremap_resource(&pdev
->dev
, res
);
1154 return ERR_CAST(ctl
);
1156 mmc
= mmc_alloc_host(sizeof(struct tmio_mmc_host
), &pdev
->dev
);
1158 return ERR_PTR(-ENOMEM
);
1160 host
= mmc_priv(mmc
);
1164 host
->pdata
= pdata
;
1165 host
->ops
= tmio_mmc_ops
;
1166 mmc
->ops
= &host
->ops
;
1168 ret
= mmc_of_parse(host
->mmc
);
1170 host
= ERR_PTR(ret
);
1174 tmio_mmc_of_parse(pdev
, mmc
);
1176 platform_set_drvdata(pdev
, host
);
1184 EXPORT_SYMBOL_GPL(tmio_mmc_host_alloc
);
1186 void tmio_mmc_host_free(struct tmio_mmc_host
*host
)
1188 mmc_free_host(host
->mmc
);
1190 EXPORT_SYMBOL_GPL(tmio_mmc_host_free
);
1192 int tmio_mmc_host_probe(struct tmio_mmc_host
*_host
)
1194 struct platform_device
*pdev
= _host
->pdev
;
1195 struct tmio_mmc_data
*pdata
= _host
->pdata
;
1196 struct mmc_host
*mmc
= _host
->mmc
;
1200 * Check the sanity of mmc->f_min to prevent tmio_mmc_set_clock() from
1201 * looping forever...
1203 if (mmc
->f_min
== 0)
1206 if (!(pdata
->flags
& TMIO_MMC_HAS_IDLE_WAIT
))
1207 _host
->write16_hook
= NULL
;
1209 _host
->set_pwr
= pdata
->set_pwr
;
1210 _host
->set_clk_div
= pdata
->set_clk_div
;
1212 ret
= tmio_mmc_init_ocr(_host
);
1216 if (pdata
->flags
& TMIO_MMC_USE_GPIO_CD
) {
1217 ret
= mmc_gpio_request_cd(mmc
, pdata
->cd_gpio
, 0);
1222 mmc
->caps
|= MMC_CAP_4_BIT_DATA
| pdata
->capabilities
;
1223 mmc
->caps2
|= pdata
->capabilities2
;
1224 mmc
->max_segs
= pdata
->max_segs
? : 32;
1225 mmc
->max_blk_size
= 512;
1226 mmc
->max_blk_count
= pdata
->max_blk_count
? :
1227 (PAGE_SIZE
/ mmc
->max_blk_size
) * mmc
->max_segs
;
1228 mmc
->max_req_size
= mmc
->max_blk_size
* mmc
->max_blk_count
;
1230 * Since swiotlb has memory size limitation, this will calculate
1231 * the maximum size locally (because we don't have any APIs for it now)
1232 * and check the current max_req_size. And then, this will update
1233 * the max_req_size if needed as a workaround.
1235 if (swiotlb_max_segment()) {
1236 unsigned int max_size
= (1 << IO_TLB_SHIFT
) * IO_TLB_SEGSIZE
;
1238 if (mmc
->max_req_size
> max_size
)
1239 mmc
->max_req_size
= max_size
;
1241 mmc
->max_seg_size
= mmc
->max_req_size
;
1243 if (mmc_can_gpio_ro(mmc
))
1244 _host
->ops
.get_ro
= mmc_gpio_get_ro
;
1246 if (mmc_can_gpio_cd(mmc
))
1247 _host
->ops
.get_cd
= mmc_gpio_get_cd
;
1249 _host
->native_hotplug
= !(mmc_can_gpio_cd(mmc
) ||
1250 mmc
->caps
& MMC_CAP_NEEDS_POLL
||
1251 !mmc_card_is_removable(mmc
));
1254 * On Gen2+, eMMC with NONREMOVABLE currently fails because native
1255 * hotplug gets disabled. It seems RuntimePM related yet we need further
1256 * research. Since we are planning a PM overhaul anyway, let's enforce
1257 * for now the device being active by enabling native hotplug always.
1259 if (pdata
->flags
& TMIO_MMC_MIN_RCAR2
)
1260 _host
->native_hotplug
= true;
1263 * While using internal tmio hardware logic for card detection, we need
1264 * to ensure it stays powered for it to work.
1266 if (_host
->native_hotplug
)
1267 pm_runtime_get_noresume(&pdev
->dev
);
1269 _host
->sdio_irq_enabled
= false;
1270 if (pdata
->flags
& TMIO_MMC_SDIO_IRQ
)
1271 _host
->sdio_irq_mask
= TMIO_SDIO_MASK_ALL
;
1273 tmio_mmc_clk_stop(_host
);
1274 tmio_mmc_reset(_host
);
1276 _host
->sdcard_irq_mask
= sd_ctrl_read16_and_16_as_32(_host
, CTL_IRQ_MASK
);
1277 tmio_mmc_disable_mmc_irqs(_host
, TMIO_MASK_ALL
);
1279 if (_host
->native_hotplug
)
1280 tmio_mmc_enable_mmc_irqs(_host
,
1281 TMIO_STAT_CARD_REMOVE
| TMIO_STAT_CARD_INSERT
);
1283 spin_lock_init(&_host
->lock
);
1284 mutex_init(&_host
->ios_lock
);
1286 /* Init delayed work for request timeouts */
1287 INIT_DELAYED_WORK(&_host
->delayed_reset_work
, tmio_mmc_reset_work
);
1288 INIT_WORK(&_host
->done
, tmio_mmc_done_work
);
1290 /* See if we also get DMA */
1291 tmio_mmc_request_dma(_host
, pdata
);
1293 pm_runtime_set_active(&pdev
->dev
);
1294 pm_runtime_set_autosuspend_delay(&pdev
->dev
, 50);
1295 pm_runtime_use_autosuspend(&pdev
->dev
);
1296 pm_runtime_enable(&pdev
->dev
);
1298 ret
= mmc_add_host(mmc
);
1302 dev_pm_qos_expose_latency_limit(&pdev
->dev
, 100);
1307 tmio_mmc_host_remove(_host
);
1310 EXPORT_SYMBOL_GPL(tmio_mmc_host_probe
);
1312 void tmio_mmc_host_remove(struct tmio_mmc_host
*host
)
1314 struct platform_device
*pdev
= host
->pdev
;
1315 struct mmc_host
*mmc
= host
->mmc
;
1317 if (host
->pdata
->flags
& TMIO_MMC_SDIO_IRQ
)
1318 sd_ctrl_write16(host
, CTL_TRANSACTION_CTL
, 0x0000);
1320 if (!host
->native_hotplug
)
1321 pm_runtime_get_sync(&pdev
->dev
);
1323 dev_pm_qos_hide_latency_limit(&pdev
->dev
);
1325 mmc_remove_host(mmc
);
1326 cancel_work_sync(&host
->done
);
1327 cancel_delayed_work_sync(&host
->delayed_reset_work
);
1328 tmio_mmc_release_dma(host
);
1330 pm_runtime_put_sync(&pdev
->dev
);
1331 pm_runtime_disable(&pdev
->dev
);
1333 EXPORT_SYMBOL_GPL(tmio_mmc_host_remove
);
1336 static int tmio_mmc_clk_enable(struct tmio_mmc_host
*host
)
1338 if (!host
->clk_enable
)
1341 return host
->clk_enable(host
);
1344 static void tmio_mmc_clk_disable(struct tmio_mmc_host
*host
)
1346 if (host
->clk_disable
)
1347 host
->clk_disable(host
);
1350 int tmio_mmc_host_runtime_suspend(struct device
*dev
)
1352 struct tmio_mmc_host
*host
= dev_get_drvdata(dev
);
1354 tmio_mmc_disable_mmc_irqs(host
, TMIO_MASK_ALL
);
1356 if (host
->clk_cache
)
1357 tmio_mmc_clk_stop(host
);
1359 tmio_mmc_clk_disable(host
);
1363 EXPORT_SYMBOL_GPL(tmio_mmc_host_runtime_suspend
);
1365 static bool tmio_mmc_can_retune(struct tmio_mmc_host
*host
)
1367 return host
->tap_num
&& mmc_can_retune(host
->mmc
);
1370 int tmio_mmc_host_runtime_resume(struct device
*dev
)
1372 struct tmio_mmc_host
*host
= dev_get_drvdata(dev
);
1374 tmio_mmc_reset(host
);
1375 tmio_mmc_clk_enable(host
);
1377 if (host
->clk_cache
)
1378 tmio_mmc_set_clock(host
, host
->clk_cache
);
1380 if (host
->native_hotplug
)
1381 tmio_mmc_enable_mmc_irqs(host
,
1382 TMIO_STAT_CARD_REMOVE
| TMIO_STAT_CARD_INSERT
);
1384 tmio_mmc_enable_dma(host
, true);
1386 if (tmio_mmc_can_retune(host
) && host
->select_tuning(host
))
1387 dev_warn(&host
->pdev
->dev
, "Tuning selection failed\n");
1391 EXPORT_SYMBOL_GPL(tmio_mmc_host_runtime_resume
);
1394 MODULE_LICENSE("GPL v2");