2 * linux/drivers/mmc/host/tmio_mmc_pio.c
4 * Copyright (C) 2016 Sang Engineering, Wolfram Sang
5 * Copyright (C) 2015-16 Renesas Electronics Corporation
6 * Copyright (C) 2011 Guennadi Liakhovetski
7 * Copyright (C) 2007 Ian Molton
8 * Copyright (C) 2004 Ian Molton
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 * Driver for the MMC / SD / SDIO IP found in:
16 * TC6393XB, TC6391XB, TC6387XB, T7L66XB, ASIC3, SH-Mobile SoCs
18 * This driver draws mainly on scattered spec sheets, Reverse engineering
19 * of the toshiba e800 SD driver and some parts of the 2.4 ASIC3 driver (4 bit
20 * support). (Further 4 bit support from a later datasheet).
23 * Investigate using a workqueue for PIO transfers
25 * Better Power management
26 * Handle MMC errors better
27 * double buffer support
31 #include <linux/delay.h>
32 #include <linux/device.h>
33 #include <linux/highmem.h>
34 #include <linux/interrupt.h>
36 #include <linux/irq.h>
37 #include <linux/mfd/tmio.h>
38 #include <linux/mmc/card.h>
39 #include <linux/mmc/host.h>
40 #include <linux/mmc/mmc.h>
41 #include <linux/mmc/slot-gpio.h>
42 #include <linux/module.h>
43 #include <linux/pagemap.h>
44 #include <linux/platform_device.h>
45 #include <linux/pm_qos.h>
46 #include <linux/pm_runtime.h>
47 #include <linux/regulator/consumer.h>
48 #include <linux/mmc/sdio.h>
49 #include <linux/scatterlist.h>
50 #include <linux/spinlock.h>
51 #include <linux/workqueue.h>
55 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host
*host
, u32 i
)
57 host
->sdcard_irq_mask
&= ~(i
& TMIO_MASK_IRQ
);
58 sd_ctrl_write32_as_16_and_16(host
, CTL_IRQ_MASK
, host
->sdcard_irq_mask
);
61 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host
*host
, u32 i
)
63 host
->sdcard_irq_mask
|= (i
& TMIO_MASK_IRQ
);
64 sd_ctrl_write32_as_16_and_16(host
, CTL_IRQ_MASK
, host
->sdcard_irq_mask
);
67 static void tmio_mmc_ack_mmc_irqs(struct tmio_mmc_host
*host
, u32 i
)
69 sd_ctrl_write32_as_16_and_16(host
, CTL_STATUS
, ~i
);
72 static void tmio_mmc_init_sg(struct tmio_mmc_host
*host
, struct mmc_data
*data
)
74 host
->sg_len
= data
->sg_len
;
75 host
->sg_ptr
= data
->sg
;
76 host
->sg_orig
= data
->sg
;
80 static int tmio_mmc_next_sg(struct tmio_mmc_host
*host
)
82 host
->sg_ptr
= sg_next(host
->sg_ptr
);
84 return --host
->sg_len
;
87 #define CMDREQ_TIMEOUT 5000
89 #ifdef CONFIG_MMC_DEBUG
91 #define STATUS_TO_TEXT(a, status, i) \
93 if (status & TMIO_STAT_##a) { \
100 static void pr_debug_status(u32 status
)
103 pr_debug("status: %08x = ", status
);
104 STATUS_TO_TEXT(CARD_REMOVE
, status
, i
);
105 STATUS_TO_TEXT(CARD_INSERT
, status
, i
);
106 STATUS_TO_TEXT(SIGSTATE
, status
, i
);
107 STATUS_TO_TEXT(WRPROTECT
, status
, i
);
108 STATUS_TO_TEXT(CARD_REMOVE_A
, status
, i
);
109 STATUS_TO_TEXT(CARD_INSERT_A
, status
, i
);
110 STATUS_TO_TEXT(SIGSTATE_A
, status
, i
);
111 STATUS_TO_TEXT(CMD_IDX_ERR
, status
, i
);
112 STATUS_TO_TEXT(STOPBIT_ERR
, status
, i
);
113 STATUS_TO_TEXT(ILL_FUNC
, status
, i
);
114 STATUS_TO_TEXT(CMD_BUSY
, status
, i
);
115 STATUS_TO_TEXT(CMDRESPEND
, status
, i
);
116 STATUS_TO_TEXT(DATAEND
, status
, i
);
117 STATUS_TO_TEXT(CRCFAIL
, status
, i
);
118 STATUS_TO_TEXT(DATATIMEOUT
, status
, i
);
119 STATUS_TO_TEXT(CMDTIMEOUT
, status
, i
);
120 STATUS_TO_TEXT(RXOVERFLOW
, status
, i
);
121 STATUS_TO_TEXT(TXUNDERRUN
, status
, i
);
122 STATUS_TO_TEXT(RXRDY
, status
, i
);
123 STATUS_TO_TEXT(TXRQ
, status
, i
);
124 STATUS_TO_TEXT(ILL_ACCESS
, status
, i
);
129 #define pr_debug_status(s) do { } while (0)
132 static void tmio_mmc_enable_sdio_irq(struct mmc_host
*mmc
, int enable
)
134 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
136 if (enable
&& !host
->sdio_irq_enabled
) {
137 /* Keep device active while SDIO irq is enabled */
138 pm_runtime_get_sync(mmc_dev(mmc
));
139 host
->sdio_irq_enabled
= true;
141 host
->sdio_irq_mask
= TMIO_SDIO_MASK_ALL
&
142 ~TMIO_SDIO_STAT_IOIRQ
;
143 sd_ctrl_write16(host
, CTL_TRANSACTION_CTL
, 0x0001);
144 sd_ctrl_write16(host
, CTL_SDIO_IRQ_MASK
, host
->sdio_irq_mask
);
145 } else if (!enable
&& host
->sdio_irq_enabled
) {
146 host
->sdio_irq_mask
= TMIO_SDIO_MASK_ALL
;
147 sd_ctrl_write16(host
, CTL_SDIO_IRQ_MASK
, host
->sdio_irq_mask
);
148 sd_ctrl_write16(host
, CTL_TRANSACTION_CTL
, 0x0000);
150 host
->sdio_irq_enabled
= false;
151 pm_runtime_mark_last_busy(mmc_dev(mmc
));
152 pm_runtime_put_autosuspend(mmc_dev(mmc
));
156 static void tmio_mmc_clk_start(struct tmio_mmc_host
*host
)
158 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, CLK_CTL_SCLKEN
|
159 sd_ctrl_read16(host
, CTL_SD_CARD_CLK_CTL
));
160 msleep(host
->pdata
->flags
& TMIO_MMC_MIN_RCAR2
? 1 : 10);
162 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
) {
163 sd_ctrl_write16(host
, CTL_CLK_AND_WAIT_CTL
, 0x0100);
168 static void tmio_mmc_clk_stop(struct tmio_mmc_host
*host
)
170 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
) {
171 sd_ctrl_write16(host
, CTL_CLK_AND_WAIT_CTL
, 0x0000);
175 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, ~CLK_CTL_SCLKEN
&
176 sd_ctrl_read16(host
, CTL_SD_CARD_CLK_CTL
));
177 msleep(host
->pdata
->flags
& TMIO_MMC_MIN_RCAR2
? 5 : 10);
180 static void tmio_mmc_set_clock(struct tmio_mmc_host
*host
,
181 unsigned int new_clock
)
185 if (new_clock
== 0) {
186 tmio_mmc_clk_stop(host
);
190 if (host
->clk_update
)
191 clock
= host
->clk_update(host
, new_clock
) / 512;
193 clock
= host
->mmc
->f_min
;
195 for (clk
= 0x80000080; new_clock
>= (clock
<< 1); clk
>>= 1)
198 /* 1/1 clock is option */
199 if ((host
->pdata
->flags
& TMIO_MMC_CLK_ACTUAL
) && ((clk
>> 22) & 0x1))
202 if (host
->set_clk_div
)
203 host
->set_clk_div(host
->pdev
, (clk
>> 22) & 1);
205 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, ~CLK_CTL_SCLKEN
&
206 sd_ctrl_read16(host
, CTL_SD_CARD_CLK_CTL
));
207 sd_ctrl_write16(host
, CTL_SD_CARD_CLK_CTL
, clk
& CLK_CTL_DIV_MASK
);
208 if (!(host
->pdata
->flags
& TMIO_MMC_MIN_RCAR2
))
211 tmio_mmc_clk_start(host
);
214 static void tmio_mmc_reset(struct tmio_mmc_host
*host
)
216 /* FIXME - should we set stop clock reg here */
217 sd_ctrl_write16(host
, CTL_RESET_SD
, 0x0000);
218 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
)
219 sd_ctrl_write16(host
, CTL_RESET_SDIO
, 0x0000);
221 sd_ctrl_write16(host
, CTL_RESET_SD
, 0x0001);
222 if (host
->pdata
->flags
& TMIO_MMC_HAVE_HIGH_REG
)
223 sd_ctrl_write16(host
, CTL_RESET_SDIO
, 0x0001);
227 static void tmio_mmc_reset_work(struct work_struct
*work
)
229 struct tmio_mmc_host
*host
= container_of(work
, struct tmio_mmc_host
,
230 delayed_reset_work
.work
);
231 struct mmc_request
*mrq
;
234 spin_lock_irqsave(&host
->lock
, flags
);
238 * is request already finished? Since we use a non-blocking
239 * cancel_delayed_work(), it can happen, that a .set_ios() call preempts
240 * us, so, have to check for IS_ERR(host->mrq)
242 if (IS_ERR_OR_NULL(mrq
)
243 || time_is_after_jiffies(host
->last_req_ts
+
244 msecs_to_jiffies(CMDREQ_TIMEOUT
))) {
245 spin_unlock_irqrestore(&host
->lock
, flags
);
249 dev_warn(&host
->pdev
->dev
,
250 "timeout waiting for hardware interrupt (CMD%u)\n",
254 host
->data
->error
= -ETIMEDOUT
;
256 host
->cmd
->error
= -ETIMEDOUT
;
258 mrq
->cmd
->error
= -ETIMEDOUT
;
262 host
->force_pio
= false;
264 spin_unlock_irqrestore(&host
->lock
, flags
);
266 tmio_mmc_reset(host
);
268 /* Ready for new calls */
271 tmio_mmc_abort_dma(host
);
272 mmc_request_done(host
->mmc
, mrq
);
275 /* called with host->lock held, interrupts disabled */
276 static void tmio_mmc_finish_request(struct tmio_mmc_host
*host
)
278 struct mmc_request
*mrq
;
281 spin_lock_irqsave(&host
->lock
, flags
);
284 if (IS_ERR_OR_NULL(mrq
)) {
285 spin_unlock_irqrestore(&host
->lock
, flags
);
291 host
->force_pio
= false;
293 cancel_delayed_work(&host
->delayed_reset_work
);
296 spin_unlock_irqrestore(&host
->lock
, flags
);
298 if (mrq
->cmd
->error
|| (mrq
->data
&& mrq
->data
->error
))
299 tmio_mmc_abort_dma(host
);
301 if (host
->check_scc_error
)
302 host
->check_scc_error(host
);
304 mmc_request_done(host
->mmc
, mrq
);
307 static void tmio_mmc_done_work(struct work_struct
*work
)
309 struct tmio_mmc_host
*host
= container_of(work
, struct tmio_mmc_host
,
311 tmio_mmc_finish_request(host
);
314 /* These are the bitmasks the tmio chip requires to implement the MMC response
315 * types. Note that R1 and R6 are the same in this scheme. */
316 #define APP_CMD 0x0040
317 #define RESP_NONE 0x0300
318 #define RESP_R1 0x0400
319 #define RESP_R1B 0x0500
320 #define RESP_R2 0x0600
321 #define RESP_R3 0x0700
322 #define DATA_PRESENT 0x0800
323 #define TRANSFER_READ 0x1000
324 #define TRANSFER_MULTI 0x2000
325 #define SECURITY_CMD 0x4000
326 #define NO_CMD12_ISSUE 0x4000 /* TMIO_MMC_HAVE_CMD12_CTRL */
328 static int tmio_mmc_start_command(struct tmio_mmc_host
*host
, struct mmc_command
*cmd
)
330 struct mmc_data
*data
= host
->data
;
332 u32 irq_mask
= TMIO_MASK_CMD
;
334 /* CMD12 is handled by hardware */
335 if (cmd
->opcode
== MMC_STOP_TRANSMISSION
&& !cmd
->arg
) {
336 sd_ctrl_write16(host
, CTL_STOP_INTERNAL_ACTION
, 0x001);
340 switch (mmc_resp_type(cmd
)) {
341 case MMC_RSP_NONE
: c
|= RESP_NONE
; break;
343 case MMC_RSP_R1_NO_CRC
:
345 case MMC_RSP_R1B
: c
|= RESP_R1B
; break;
346 case MMC_RSP_R2
: c
|= RESP_R2
; break;
347 case MMC_RSP_R3
: c
|= RESP_R3
; break;
349 pr_debug("Unknown response type %d\n", mmc_resp_type(cmd
));
355 /* FIXME - this seems to be ok commented out but the spec suggest this bit
356 * should be set when issuing app commands.
357 * if(cmd->flags & MMC_FLAG_ACMD)
362 if (data
->blocks
> 1) {
363 sd_ctrl_write16(host
, CTL_STOP_INTERNAL_ACTION
, 0x100);
367 * Disable auto CMD12 at IO_RW_EXTENDED when
368 * multiple block transfer
370 if ((host
->pdata
->flags
& TMIO_MMC_HAVE_CMD12_CTRL
) &&
371 (cmd
->opcode
== SD_IO_RW_EXTENDED
))
374 if (data
->flags
& MMC_DATA_READ
)
378 if (!host
->native_hotplug
)
379 irq_mask
&= ~(TMIO_STAT_CARD_REMOVE
| TMIO_STAT_CARD_INSERT
);
380 tmio_mmc_enable_mmc_irqs(host
, irq_mask
);
382 /* Fire off the command */
383 sd_ctrl_write32_as_16_and_16(host
, CTL_ARG_REG
, cmd
->arg
);
384 sd_ctrl_write16(host
, CTL_SD_CMD
, c
);
389 static void tmio_mmc_transfer_data(struct tmio_mmc_host
*host
,
393 int is_read
= host
->data
->flags
& MMC_DATA_READ
;
399 if (host
->pdata
->flags
& TMIO_MMC_32BIT_DATA_PORT
) {
403 sd_ctrl_read32_rep(host
, CTL_SD_DATA_PORT
, (u32
*)buf
,
406 sd_ctrl_write32_rep(host
, CTL_SD_DATA_PORT
, (u32
*)buf
,
409 /* if count was multiple of 4 */
413 buf8
= (u8
*)(buf
+ (count
>> 2));
417 sd_ctrl_read32_rep(host
, CTL_SD_DATA_PORT
,
419 memcpy(buf8
, data
, count
);
421 memcpy(data
, buf8
, count
);
422 sd_ctrl_write32_rep(host
, CTL_SD_DATA_PORT
,
430 sd_ctrl_read16_rep(host
, CTL_SD_DATA_PORT
, buf
, count
>> 1);
432 sd_ctrl_write16_rep(host
, CTL_SD_DATA_PORT
, buf
, count
>> 1);
434 /* if count was even number */
438 /* if count was odd number */
439 buf8
= (u8
*)(buf
+ (count
>> 1));
444 * driver and this function are assuming that
445 * it is used as little endian
448 *buf8
= sd_ctrl_read16(host
, CTL_SD_DATA_PORT
) & 0xff;
450 sd_ctrl_write16(host
, CTL_SD_DATA_PORT
, *buf8
);
454 * This chip always returns (at least?) as much data as you ask for.
455 * I'm unsure what happens if you ask for less than a block. This should be
456 * looked into to ensure that a funny length read doesn't hose the controller.
458 static void tmio_mmc_pio_irq(struct tmio_mmc_host
*host
)
460 struct mmc_data
*data
= host
->data
;
466 if ((host
->chan_tx
|| host
->chan_rx
) && !host
->force_pio
) {
467 pr_err("PIO IRQ in DMA mode!\n");
470 pr_debug("Spurious PIO IRQ\n");
474 sg_virt
= tmio_mmc_kmap_atomic(host
->sg_ptr
, &flags
);
475 buf
= (unsigned short *)(sg_virt
+ host
->sg_off
);
477 count
= host
->sg_ptr
->length
- host
->sg_off
;
478 if (count
> data
->blksz
)
481 pr_debug("count: %08x offset: %08x flags %08x\n",
482 count
, host
->sg_off
, data
->flags
);
484 /* Transfer the data */
485 tmio_mmc_transfer_data(host
, buf
, count
);
487 host
->sg_off
+= count
;
489 tmio_mmc_kunmap_atomic(host
->sg_ptr
, &flags
, sg_virt
);
491 if (host
->sg_off
== host
->sg_ptr
->length
)
492 tmio_mmc_next_sg(host
);
497 static void tmio_mmc_check_bounce_buffer(struct tmio_mmc_host
*host
)
499 if (host
->sg_ptr
== &host
->bounce_sg
) {
501 void *sg_vaddr
= tmio_mmc_kmap_atomic(host
->sg_orig
, &flags
);
502 memcpy(sg_vaddr
, host
->bounce_buf
, host
->bounce_sg
.length
);
503 tmio_mmc_kunmap_atomic(host
->sg_orig
, &flags
, sg_vaddr
);
507 /* needs to be called with host->lock held */
508 void tmio_mmc_do_data_irq(struct tmio_mmc_host
*host
)
510 struct mmc_data
*data
= host
->data
;
511 struct mmc_command
*stop
;
516 dev_warn(&host
->pdev
->dev
, "Spurious data end IRQ\n");
521 /* FIXME - return correct transfer count on errors */
523 data
->bytes_xfered
= data
->blocks
* data
->blksz
;
525 data
->bytes_xfered
= 0;
527 pr_debug("Completed data request\n");
530 * FIXME: other drivers allow an optional stop command of any given type
531 * which we dont do, as the chip can auto generate them.
532 * Perhaps we can be smarter about when to use auto CMD12 and
533 * only issue the auto request when we know this is the desired
534 * stop command, allowing fallback to the stop command the
535 * upper layers expect. For now, we do what works.
538 if (data
->flags
& MMC_DATA_READ
) {
539 if (host
->chan_rx
&& !host
->force_pio
)
540 tmio_mmc_check_bounce_buffer(host
);
541 dev_dbg(&host
->pdev
->dev
, "Complete Rx request %p\n",
544 dev_dbg(&host
->pdev
->dev
, "Complete Tx request %p\n",
549 if (stop
->opcode
== MMC_STOP_TRANSMISSION
&& !stop
->arg
)
550 sd_ctrl_write16(host
, CTL_STOP_INTERNAL_ACTION
, 0x000);
555 schedule_work(&host
->done
);
558 static void tmio_mmc_data_irq(struct tmio_mmc_host
*host
, unsigned int stat
)
560 struct mmc_data
*data
;
561 spin_lock(&host
->lock
);
567 if (stat
& TMIO_STAT_CRCFAIL
|| stat
& TMIO_STAT_STOPBIT_ERR
||
568 stat
& TMIO_STAT_TXUNDERRUN
)
569 data
->error
= -EILSEQ
;
570 if (host
->chan_tx
&& (data
->flags
& MMC_DATA_WRITE
) && !host
->force_pio
) {
571 u32 status
= sd_ctrl_read16_and_16_as_32(host
, CTL_STATUS
);
575 * Has all data been written out yet? Testing on SuperH showed,
576 * that in most cases the first interrupt comes already with the
577 * BUSY status bit clear, but on some operations, like mount or
578 * in the beginning of a write / sync / umount, there is one
579 * DATAEND interrupt with the BUSY bit set, in this cases
580 * waiting for one more interrupt fixes the problem.
582 if (host
->pdata
->flags
& TMIO_MMC_HAS_IDLE_WAIT
) {
583 if (status
& TMIO_STAT_SCLKDIVEN
)
586 if (!(status
& TMIO_STAT_CMD_BUSY
))
591 tmio_mmc_disable_mmc_irqs(host
, TMIO_STAT_DATAEND
);
592 tasklet_schedule(&host
->dma_complete
);
594 } else if (host
->chan_rx
&& (data
->flags
& MMC_DATA_READ
) && !host
->force_pio
) {
595 tmio_mmc_disable_mmc_irqs(host
, TMIO_STAT_DATAEND
);
596 tasklet_schedule(&host
->dma_complete
);
598 tmio_mmc_do_data_irq(host
);
599 tmio_mmc_disable_mmc_irqs(host
, TMIO_MASK_READOP
| TMIO_MASK_WRITEOP
);
602 spin_unlock(&host
->lock
);
605 static void tmio_mmc_cmd_irq(struct tmio_mmc_host
*host
,
608 struct mmc_command
*cmd
= host
->cmd
;
611 spin_lock(&host
->lock
);
614 pr_debug("Spurious CMD irq\n");
618 /* This controller is sicker than the PXA one. Not only do we need to
619 * drop the top 8 bits of the first response word, we also need to
620 * modify the order of the response for short response command types.
623 for (i
= 3, addr
= CTL_RESPONSE
; i
>= 0 ; i
--, addr
+= 4)
624 cmd
->resp
[i
] = sd_ctrl_read16_and_16_as_32(host
, addr
);
626 if (cmd
->flags
& MMC_RSP_136
) {
627 cmd
->resp
[0] = (cmd
->resp
[0] << 8) | (cmd
->resp
[1] >> 24);
628 cmd
->resp
[1] = (cmd
->resp
[1] << 8) | (cmd
->resp
[2] >> 24);
629 cmd
->resp
[2] = (cmd
->resp
[2] << 8) | (cmd
->resp
[3] >> 24);
631 } else if (cmd
->flags
& MMC_RSP_R3
) {
632 cmd
->resp
[0] = cmd
->resp
[3];
635 if (stat
& TMIO_STAT_CMDTIMEOUT
)
636 cmd
->error
= -ETIMEDOUT
;
637 else if ((stat
& TMIO_STAT_CRCFAIL
&& cmd
->flags
& MMC_RSP_CRC
) ||
638 stat
& TMIO_STAT_STOPBIT_ERR
||
639 stat
& TMIO_STAT_CMD_IDX_ERR
)
640 cmd
->error
= -EILSEQ
;
642 /* If there is data to handle we enable data IRQs here, and
643 * we will ultimatley finish the request in the data_end handler.
644 * If theres no data or we encountered an error, finish now.
646 if (host
->data
&& (!cmd
->error
|| cmd
->error
== -EILSEQ
)) {
647 if (host
->data
->flags
& MMC_DATA_READ
) {
648 if (host
->force_pio
|| !host
->chan_rx
)
649 tmio_mmc_enable_mmc_irqs(host
, TMIO_MASK_READOP
);
651 tasklet_schedule(&host
->dma_issue
);
653 if (host
->force_pio
|| !host
->chan_tx
)
654 tmio_mmc_enable_mmc_irqs(host
, TMIO_MASK_WRITEOP
);
656 tasklet_schedule(&host
->dma_issue
);
659 schedule_work(&host
->done
);
663 spin_unlock(&host
->lock
);
666 static bool __tmio_mmc_card_detect_irq(struct tmio_mmc_host
*host
,
667 int ireg
, int status
)
669 struct mmc_host
*mmc
= host
->mmc
;
671 /* Card insert / remove attempts */
672 if (ireg
& (TMIO_STAT_CARD_INSERT
| TMIO_STAT_CARD_REMOVE
)) {
673 tmio_mmc_ack_mmc_irqs(host
, TMIO_STAT_CARD_INSERT
|
674 TMIO_STAT_CARD_REMOVE
);
675 if ((((ireg
& TMIO_STAT_CARD_REMOVE
) && mmc
->card
) ||
676 ((ireg
& TMIO_STAT_CARD_INSERT
) && !mmc
->card
)) &&
677 !work_pending(&mmc
->detect
.work
))
678 mmc_detect_change(host
->mmc
, msecs_to_jiffies(100));
685 static bool __tmio_mmc_sdcard_irq(struct tmio_mmc_host
*host
,
686 int ireg
, int status
)
688 /* Command completion */
689 if (ireg
& (TMIO_STAT_CMDRESPEND
| TMIO_STAT_CMDTIMEOUT
)) {
690 tmio_mmc_ack_mmc_irqs(host
,
691 TMIO_STAT_CMDRESPEND
|
692 TMIO_STAT_CMDTIMEOUT
);
693 tmio_mmc_cmd_irq(host
, status
);
698 if (ireg
& (TMIO_STAT_RXRDY
| TMIO_STAT_TXRQ
)) {
699 tmio_mmc_ack_mmc_irqs(host
, TMIO_STAT_RXRDY
| TMIO_STAT_TXRQ
);
700 tmio_mmc_pio_irq(host
);
704 /* Data transfer completion */
705 if (ireg
& TMIO_STAT_DATAEND
) {
706 tmio_mmc_ack_mmc_irqs(host
, TMIO_STAT_DATAEND
);
707 tmio_mmc_data_irq(host
, status
);
714 static void tmio_mmc_sdio_irq(int irq
, void *devid
)
716 struct tmio_mmc_host
*host
= devid
;
717 struct mmc_host
*mmc
= host
->mmc
;
718 struct tmio_mmc_data
*pdata
= host
->pdata
;
719 unsigned int ireg
, status
;
720 unsigned int sdio_status
;
722 if (!(pdata
->flags
& TMIO_MMC_SDIO_IRQ
))
725 status
= sd_ctrl_read16(host
, CTL_SDIO_STATUS
);
726 ireg
= status
& TMIO_SDIO_MASK_ALL
& ~host
->sdio_irq_mask
;
728 sdio_status
= status
& ~TMIO_SDIO_MASK_ALL
;
729 if (pdata
->flags
& TMIO_MMC_SDIO_STATUS_QUIRK
)
732 sd_ctrl_write16(host
, CTL_SDIO_STATUS
, sdio_status
);
734 if (mmc
->caps
& MMC_CAP_SDIO_IRQ
&& ireg
& TMIO_SDIO_STAT_IOIRQ
)
735 mmc_signal_sdio_irq(mmc
);
738 irqreturn_t
tmio_mmc_irq(int irq
, void *devid
)
740 struct tmio_mmc_host
*host
= devid
;
741 unsigned int ireg
, status
;
743 status
= sd_ctrl_read16_and_16_as_32(host
, CTL_STATUS
);
744 ireg
= status
& TMIO_MASK_IRQ
& ~host
->sdcard_irq_mask
;
746 pr_debug_status(status
);
747 pr_debug_status(ireg
);
749 /* Clear the status except the interrupt status */
750 sd_ctrl_write32_as_16_and_16(host
, CTL_STATUS
, TMIO_MASK_IRQ
);
752 if (__tmio_mmc_card_detect_irq(host
, ireg
, status
))
754 if (__tmio_mmc_sdcard_irq(host
, ireg
, status
))
757 tmio_mmc_sdio_irq(irq
, devid
);
761 EXPORT_SYMBOL(tmio_mmc_irq
);
763 static int tmio_mmc_start_data(struct tmio_mmc_host
*host
,
764 struct mmc_data
*data
)
766 struct tmio_mmc_data
*pdata
= host
->pdata
;
768 pr_debug("setup data transfer: blocksize %08x nr_blocks %d\n",
769 data
->blksz
, data
->blocks
);
771 /* Some hardware cannot perform 2 byte requests in 4/8 bit mode */
772 if (host
->mmc
->ios
.bus_width
== MMC_BUS_WIDTH_4
||
773 host
->mmc
->ios
.bus_width
== MMC_BUS_WIDTH_8
) {
774 int blksz_2bytes
= pdata
->flags
& TMIO_MMC_BLKSZ_2BYTES
;
776 if (data
->blksz
< 2 || (data
->blksz
< 4 && !blksz_2bytes
)) {
777 pr_err("%s: %d byte block unsupported in 4/8 bit mode\n",
778 mmc_hostname(host
->mmc
), data
->blksz
);
783 tmio_mmc_init_sg(host
, data
);
786 /* Set transfer length / blocksize */
787 sd_ctrl_write16(host
, CTL_SD_XFER_LEN
, data
->blksz
);
788 sd_ctrl_write16(host
, CTL_XFER_BLK_COUNT
, data
->blocks
);
790 tmio_mmc_start_dma(host
, data
);
795 static void tmio_mmc_hw_reset(struct mmc_host
*mmc
)
797 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
800 host
->hw_reset(host
);
803 static int tmio_mmc_execute_tuning(struct mmc_host
*mmc
, u32 opcode
)
805 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
808 if (!host
->tap_num
) {
809 if (!host
->init_tuning
|| !host
->select_tuning
)
810 /* Tuning is not supported */
813 host
->tap_num
= host
->init_tuning(host
);
815 /* Tuning is not supported */
819 if (host
->tap_num
* 2 >= sizeof(host
->taps
) * BITS_PER_BYTE
) {
820 dev_warn_once(&host
->pdev
->dev
,
821 "Too many taps, skipping tuning. Please consider updating size of taps field of tmio_mmc_host\n");
825 bitmap_zero(host
->taps
, host
->tap_num
* 2);
827 /* Issue CMD19 twice for each tap */
828 for (i
= 0; i
< 2 * host
->tap_num
; i
++) {
829 if (host
->prepare_tuning
)
830 host
->prepare_tuning(host
, i
% host
->tap_num
);
832 ret
= mmc_send_tuning(mmc
, opcode
, NULL
);
833 if (ret
&& ret
!= -EILSEQ
)
836 set_bit(i
, host
->taps
);
841 ret
= host
->select_tuning(host
);
845 dev_warn(&host
->pdev
->dev
, "Tuning procedure failed\n");
846 tmio_mmc_hw_reset(mmc
);
852 /* Process requests from the MMC layer */
853 static void tmio_mmc_request(struct mmc_host
*mmc
, struct mmc_request
*mrq
)
855 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
859 spin_lock_irqsave(&host
->lock
, flags
);
862 pr_debug("request not null\n");
863 if (IS_ERR(host
->mrq
)) {
864 spin_unlock_irqrestore(&host
->lock
, flags
);
865 mrq
->cmd
->error
= -EAGAIN
;
866 mmc_request_done(mmc
, mrq
);
871 host
->last_req_ts
= jiffies
;
875 spin_unlock_irqrestore(&host
->lock
, flags
);
878 ret
= tmio_mmc_start_data(host
, mrq
->data
);
883 ret
= tmio_mmc_start_command(host
, mrq
->cmd
);
885 schedule_delayed_work(&host
->delayed_reset_work
,
886 msecs_to_jiffies(CMDREQ_TIMEOUT
));
891 host
->force_pio
= false;
893 mrq
->cmd
->error
= ret
;
894 mmc_request_done(mmc
, mrq
);
897 static int tmio_mmc_clk_enable(struct tmio_mmc_host
*host
)
899 if (!host
->clk_enable
)
902 return host
->clk_enable(host
);
905 static void tmio_mmc_power_on(struct tmio_mmc_host
*host
, unsigned short vdd
)
907 struct mmc_host
*mmc
= host
->mmc
;
910 /* .set_ios() is returning void, so, no chance to report an error */
913 host
->set_pwr(host
->pdev
, 1);
915 if (!IS_ERR(mmc
->supply
.vmmc
)) {
916 ret
= mmc_regulator_set_ocr(mmc
, mmc
->supply
.vmmc
, vdd
);
918 * Attention: empiric value. With a b43 WiFi SDIO card this
919 * delay proved necessary for reliable card-insertion probing.
920 * 100us were not enough. Is this the same 140us delay, as in
921 * tmio_mmc_set_ios()?
926 * It seems, VccQ should be switched on after Vcc, this is also what the
927 * omap_hsmmc.c driver does.
929 if (!IS_ERR(mmc
->supply
.vqmmc
) && !ret
) {
930 ret
= regulator_enable(mmc
->supply
.vqmmc
);
935 dev_dbg(&host
->pdev
->dev
, "Regulators failed to power up: %d\n",
939 static void tmio_mmc_power_off(struct tmio_mmc_host
*host
)
941 struct mmc_host
*mmc
= host
->mmc
;
943 if (!IS_ERR(mmc
->supply
.vqmmc
))
944 regulator_disable(mmc
->supply
.vqmmc
);
946 if (!IS_ERR(mmc
->supply
.vmmc
))
947 mmc_regulator_set_ocr(mmc
, mmc
->supply
.vmmc
, 0);
950 host
->set_pwr(host
->pdev
, 0);
953 static void tmio_mmc_set_bus_width(struct tmio_mmc_host
*host
,
954 unsigned char bus_width
)
956 u16 reg
= sd_ctrl_read16(host
, CTL_SD_MEM_CARD_OPT
)
957 & ~(CARD_OPT_WIDTH
| CARD_OPT_WIDTH8
);
959 /* reg now applies to MMC_BUS_WIDTH_4 */
960 if (bus_width
== MMC_BUS_WIDTH_1
)
961 reg
|= CARD_OPT_WIDTH
;
962 else if (bus_width
== MMC_BUS_WIDTH_8
)
963 reg
|= CARD_OPT_WIDTH8
;
965 sd_ctrl_write16(host
, CTL_SD_MEM_CARD_OPT
, reg
);
968 /* Set MMC clock / power.
969 * Note: This controller uses a simple divider scheme therefore it cannot
970 * run a MMC card at full speed (20MHz). The max clock is 24MHz on SD, but as
971 * MMC wont run that fast, it has to be clocked at 12MHz which is the next
974 static void tmio_mmc_set_ios(struct mmc_host
*mmc
, struct mmc_ios
*ios
)
976 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
977 struct device
*dev
= &host
->pdev
->dev
;
980 mutex_lock(&host
->ios_lock
);
982 spin_lock_irqsave(&host
->lock
, flags
);
984 if (IS_ERR(host
->mrq
)) {
986 "%s.%d: concurrent .set_ios(), clk %u, mode %u\n",
987 current
->comm
, task_pid_nr(current
),
988 ios
->clock
, ios
->power_mode
);
989 host
->mrq
= ERR_PTR(-EINTR
);
992 "%s.%d: CMD%u active since %lu, now %lu!\n",
993 current
->comm
, task_pid_nr(current
),
994 host
->mrq
->cmd
->opcode
, host
->last_req_ts
, jiffies
);
996 spin_unlock_irqrestore(&host
->lock
, flags
);
998 mutex_unlock(&host
->ios_lock
);
1002 host
->mrq
= ERR_PTR(-EBUSY
);
1004 spin_unlock_irqrestore(&host
->lock
, flags
);
1006 switch (ios
->power_mode
) {
1008 tmio_mmc_power_off(host
);
1009 tmio_mmc_clk_stop(host
);
1012 tmio_mmc_power_on(host
, ios
->vdd
);
1013 tmio_mmc_set_clock(host
, ios
->clock
);
1014 tmio_mmc_set_bus_width(host
, ios
->bus_width
);
1017 tmio_mmc_set_clock(host
, ios
->clock
);
1018 tmio_mmc_set_bus_width(host
, ios
->bus_width
);
1022 /* Let things settle. delay taken from winCE driver */
1024 if (PTR_ERR(host
->mrq
) == -EINTR
)
1025 dev_dbg(&host
->pdev
->dev
,
1026 "%s.%d: IOS interrupted: clk %u, mode %u",
1027 current
->comm
, task_pid_nr(current
),
1028 ios
->clock
, ios
->power_mode
);
1031 host
->clk_cache
= ios
->clock
;
1033 mutex_unlock(&host
->ios_lock
);
1036 static int tmio_mmc_get_ro(struct mmc_host
*mmc
)
1038 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
1039 struct tmio_mmc_data
*pdata
= host
->pdata
;
1040 int ret
= mmc_gpio_get_ro(mmc
);
1044 ret
= !((pdata
->flags
& TMIO_MMC_WRPROTECT_DISABLE
) ||
1045 (sd_ctrl_read16_and_16_as_32(host
, CTL_STATUS
) & TMIO_STAT_WRPROTECT
));
1050 static int tmio_multi_io_quirk(struct mmc_card
*card
,
1051 unsigned int direction
, int blk_size
)
1053 struct tmio_mmc_host
*host
= mmc_priv(card
->host
);
1055 if (host
->multi_io_quirk
)
1056 return host
->multi_io_quirk(card
, direction
, blk_size
);
1061 static struct mmc_host_ops tmio_mmc_ops
= {
1062 .request
= tmio_mmc_request
,
1063 .set_ios
= tmio_mmc_set_ios
,
1064 .get_ro
= tmio_mmc_get_ro
,
1065 .get_cd
= mmc_gpio_get_cd
,
1066 .enable_sdio_irq
= tmio_mmc_enable_sdio_irq
,
1067 .multi_io_quirk
= tmio_multi_io_quirk
,
1068 .hw_reset
= tmio_mmc_hw_reset
,
1069 .execute_tuning
= tmio_mmc_execute_tuning
,
1072 static int tmio_mmc_init_ocr(struct tmio_mmc_host
*host
)
1074 struct tmio_mmc_data
*pdata
= host
->pdata
;
1075 struct mmc_host
*mmc
= host
->mmc
;
1077 mmc_regulator_get_supply(mmc
);
1079 /* use ocr_mask if no regulator */
1080 if (!mmc
->ocr_avail
)
1081 mmc
->ocr_avail
= pdata
->ocr_mask
;
1085 * There is possibility that regulator has not been probed
1087 if (!mmc
->ocr_avail
)
1088 return -EPROBE_DEFER
;
1093 static void tmio_mmc_of_parse(struct platform_device
*pdev
,
1094 struct tmio_mmc_data
*pdata
)
1096 const struct device_node
*np
= pdev
->dev
.of_node
;
1100 if (of_get_property(np
, "toshiba,mmc-wrprotect-disable", NULL
))
1101 pdata
->flags
|= TMIO_MMC_WRPROTECT_DISABLE
;
1104 struct tmio_mmc_host
*
1105 tmio_mmc_host_alloc(struct platform_device
*pdev
)
1107 struct tmio_mmc_host
*host
;
1108 struct mmc_host
*mmc
;
1110 mmc
= mmc_alloc_host(sizeof(struct tmio_mmc_host
), &pdev
->dev
);
1114 host
= mmc_priv(mmc
);
1120 EXPORT_SYMBOL(tmio_mmc_host_alloc
);
1122 void tmio_mmc_host_free(struct tmio_mmc_host
*host
)
1124 mmc_free_host(host
->mmc
);
1126 EXPORT_SYMBOL(tmio_mmc_host_free
);
1128 int tmio_mmc_host_probe(struct tmio_mmc_host
*_host
,
1129 struct tmio_mmc_data
*pdata
)
1131 struct platform_device
*pdev
= _host
->pdev
;
1132 struct mmc_host
*mmc
= _host
->mmc
;
1133 struct resource
*res_ctl
;
1135 u32 irq_mask
= TMIO_MASK_CMD
;
1137 tmio_mmc_of_parse(pdev
, pdata
);
1139 if (!(pdata
->flags
& TMIO_MMC_HAS_IDLE_WAIT
))
1140 _host
->write16_hook
= NULL
;
1142 res_ctl
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1146 ret
= mmc_of_parse(mmc
);
1150 _host
->pdata
= pdata
;
1151 platform_set_drvdata(pdev
, mmc
);
1153 _host
->set_pwr
= pdata
->set_pwr
;
1154 _host
->set_clk_div
= pdata
->set_clk_div
;
1156 ret
= tmio_mmc_init_ocr(_host
);
1160 _host
->ctl
= devm_ioremap(&pdev
->dev
,
1161 res_ctl
->start
, resource_size(res_ctl
));
1167 tmio_mmc_ops
.card_busy
= _host
->card_busy
;
1168 tmio_mmc_ops
.start_signal_voltage_switch
= _host
->start_signal_voltage_switch
;
1169 mmc
->ops
= &tmio_mmc_ops
;
1171 mmc
->caps
|= MMC_CAP_4_BIT_DATA
| pdata
->capabilities
;
1172 mmc
->caps2
|= pdata
->capabilities2
;
1174 mmc
->max_blk_size
= 512;
1175 mmc
->max_blk_count
= (PAGE_SIZE
/ mmc
->max_blk_size
) *
1177 mmc
->max_req_size
= mmc
->max_blk_size
* mmc
->max_blk_count
;
1178 mmc
->max_seg_size
= mmc
->max_req_size
;
1180 _host
->native_hotplug
= !(pdata
->flags
& TMIO_MMC_USE_GPIO_CD
||
1181 mmc
->caps
& MMC_CAP_NEEDS_POLL
||
1182 !mmc_card_is_removable(mmc
) ||
1183 mmc
->slot
.cd_irq
>= 0);
1186 * On Gen2+, eMMC with NONREMOVABLE currently fails because native
1187 * hotplug gets disabled. It seems RuntimePM related yet we need further
1188 * research. Since we are planning a PM overhaul anyway, let's enforce
1189 * for now the device being active by enabling native hotplug always.
1191 if (pdata
->flags
& TMIO_MMC_MIN_RCAR2
)
1192 _host
->native_hotplug
= true;
1194 if (tmio_mmc_clk_enable(_host
) < 0) {
1195 mmc
->f_max
= pdata
->hclk
;
1196 mmc
->f_min
= mmc
->f_max
/ 512;
1200 * Check the sanity of mmc->f_min to prevent tmio_mmc_set_clock() from
1201 * looping forever...
1203 if (mmc
->f_min
== 0) {
1209 * While using internal tmio hardware logic for card detection, we need
1210 * to ensure it stays powered for it to work.
1212 if (_host
->native_hotplug
)
1213 pm_runtime_get_noresume(&pdev
->dev
);
1215 tmio_mmc_clk_stop(_host
);
1216 tmio_mmc_reset(_host
);
1218 _host
->sdcard_irq_mask
= sd_ctrl_read16_and_16_as_32(_host
, CTL_IRQ_MASK
);
1219 tmio_mmc_disable_mmc_irqs(_host
, TMIO_MASK_ALL
);
1221 /* Unmask the IRQs we want to know about */
1222 if (!_host
->chan_rx
)
1223 irq_mask
|= TMIO_MASK_READOP
;
1224 if (!_host
->chan_tx
)
1225 irq_mask
|= TMIO_MASK_WRITEOP
;
1226 if (!_host
->native_hotplug
)
1227 irq_mask
&= ~(TMIO_STAT_CARD_REMOVE
| TMIO_STAT_CARD_INSERT
);
1229 _host
->sdcard_irq_mask
&= ~irq_mask
;
1231 _host
->sdio_irq_enabled
= false;
1232 if (pdata
->flags
& TMIO_MMC_SDIO_IRQ
) {
1233 _host
->sdio_irq_mask
= TMIO_SDIO_MASK_ALL
;
1234 sd_ctrl_write16(_host
, CTL_SDIO_IRQ_MASK
, _host
->sdio_irq_mask
);
1235 sd_ctrl_write16(_host
, CTL_TRANSACTION_CTL
, 0x0000);
1238 spin_lock_init(&_host
->lock
);
1239 mutex_init(&_host
->ios_lock
);
1241 /* Init delayed work for request timeouts */
1242 INIT_DELAYED_WORK(&_host
->delayed_reset_work
, tmio_mmc_reset_work
);
1243 INIT_WORK(&_host
->done
, tmio_mmc_done_work
);
1245 /* See if we also get DMA */
1246 tmio_mmc_request_dma(_host
, pdata
);
1248 pm_runtime_set_active(&pdev
->dev
);
1249 pm_runtime_set_autosuspend_delay(&pdev
->dev
, 50);
1250 pm_runtime_use_autosuspend(&pdev
->dev
);
1251 pm_runtime_enable(&pdev
->dev
);
1253 ret
= mmc_add_host(mmc
);
1255 tmio_mmc_host_remove(_host
);
1259 dev_pm_qos_expose_latency_limit(&pdev
->dev
, 100);
1261 if (pdata
->flags
& TMIO_MMC_USE_GPIO_CD
) {
1262 ret
= mmc_gpio_request_cd(mmc
, pdata
->cd_gpio
, 0);
1264 tmio_mmc_host_remove(_host
);
1267 mmc_gpiod_request_cd_irq(mmc
);
1276 EXPORT_SYMBOL(tmio_mmc_host_probe
);
1278 void tmio_mmc_host_remove(struct tmio_mmc_host
*host
)
1280 struct platform_device
*pdev
= host
->pdev
;
1281 struct mmc_host
*mmc
= host
->mmc
;
1283 if (!host
->native_hotplug
)
1284 pm_runtime_get_sync(&pdev
->dev
);
1286 dev_pm_qos_hide_latency_limit(&pdev
->dev
);
1288 mmc_remove_host(mmc
);
1289 cancel_work_sync(&host
->done
);
1290 cancel_delayed_work_sync(&host
->delayed_reset_work
);
1291 tmio_mmc_release_dma(host
);
1293 pm_runtime_put_sync(&pdev
->dev
);
1294 pm_runtime_disable(&pdev
->dev
);
1296 EXPORT_SYMBOL(tmio_mmc_host_remove
);
1299 int tmio_mmc_host_runtime_suspend(struct device
*dev
)
1301 struct mmc_host
*mmc
= dev_get_drvdata(dev
);
1302 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
1304 tmio_mmc_disable_mmc_irqs(host
, TMIO_MASK_ALL
);
1306 if (host
->clk_cache
)
1307 tmio_mmc_clk_stop(host
);
1309 if (host
->clk_disable
)
1310 host
->clk_disable(host
);
1314 EXPORT_SYMBOL(tmio_mmc_host_runtime_suspend
);
1316 static bool tmio_mmc_can_retune(struct tmio_mmc_host
*host
)
1318 return host
->tap_num
&& mmc_can_retune(host
->mmc
);
1321 int tmio_mmc_host_runtime_resume(struct device
*dev
)
1323 struct mmc_host
*mmc
= dev_get_drvdata(dev
);
1324 struct tmio_mmc_host
*host
= mmc_priv(mmc
);
1326 tmio_mmc_reset(host
);
1327 tmio_mmc_clk_enable(host
);
1329 if (host
->clk_cache
)
1330 tmio_mmc_set_clock(host
, host
->clk_cache
);
1332 tmio_mmc_enable_dma(host
, true);
1334 if (tmio_mmc_can_retune(host
) && host
->select_tuning(host
))
1335 dev_warn(&host
->pdev
->dev
, "Tuning selection failed\n");
1339 EXPORT_SYMBOL(tmio_mmc_host_runtime_resume
);
1342 MODULE_LICENSE("GPL v2");