mmc: tmio: Keep host active while SDIO IRQ is enabled
[platform/adaptation/renesas_rcar/renesas_kernel.git] / drivers / mmc / host / tmio_mmc_pio.c
1 /*
2  * linux/drivers/mmc/host/tmio_mmc_pio.c
3  *
4  * Copyright (C) 2011 Guennadi Liakhovetski
5  * Copyright (C) 2007 Ian Molton
6  * Copyright (C) 2004 Ian Molton
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  *
12  * Driver for the MMC / SD / SDIO IP found in:
13  *
14  * TC6393XB, TC6391XB, TC6387XB, T7L66XB, ASIC3, SH-Mobile SoCs
15  *
16  * This driver draws mainly on scattered spec sheets, Reverse engineering
17  * of the toshiba e800  SD driver and some parts of the 2.4 ASIC3 driver (4 bit
18  * support). (Further 4 bit support from a later datasheet).
19  *
20  * TODO:
21  *   Investigate using a workqueue for PIO transfers
22  *   Eliminate FIXMEs
23  *   SDIO support
24  *   Better Power management
25  *   Handle MMC errors better
26  *   double buffer support
27  *
28  */
29
30 #include <linux/delay.h>
31 #include <linux/device.h>
32 #include <linux/highmem.h>
33 #include <linux/interrupt.h>
34 #include <linux/io.h>
35 #include <linux/irq.h>
36 #include <linux/mfd/tmio.h>
37 #include <linux/mmc/host.h>
38 #include <linux/mmc/mmc.h>
39 #include <linux/mmc/slot-gpio.h>
40 #include <linux/mmc/tmio.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/scatterlist.h>
48 #include <linux/spinlock.h>
49 #include <linux/workqueue.h>
50
51 #include "tmio_mmc.h"
52
53 void tmio_mmc_enable_mmc_irqs(struct tmio_mmc_host *host, u32 i)
54 {
55         host->sdcard_irq_mask &= ~(i & TMIO_MASK_IRQ);
56         sd_ctrl_write32(host, CTL_IRQ_MASK, host->sdcard_irq_mask);
57 }
58
59 void tmio_mmc_disable_mmc_irqs(struct tmio_mmc_host *host, u32 i)
60 {
61         host->sdcard_irq_mask |= (i & TMIO_MASK_IRQ);
62         sd_ctrl_write32(host, CTL_IRQ_MASK, host->sdcard_irq_mask);
63 }
64
65 static void tmio_mmc_ack_mmc_irqs(struct tmio_mmc_host *host, u32 i)
66 {
67         sd_ctrl_write32(host, CTL_STATUS, ~i);
68 }
69
70 static void tmio_mmc_init_sg(struct tmio_mmc_host *host, struct mmc_data *data)
71 {
72         host->sg_len = data->sg_len;
73         host->sg_ptr = data->sg;
74         host->sg_orig = data->sg;
75         host->sg_off = 0;
76 }
77
78 static int tmio_mmc_next_sg(struct tmio_mmc_host *host)
79 {
80         host->sg_ptr = sg_next(host->sg_ptr);
81         host->sg_off = 0;
82         return --host->sg_len;
83 }
84
85 #ifdef CONFIG_MMC_DEBUG
86
87 #define STATUS_TO_TEXT(a, status, i) \
88         do { \
89                 if (status & TMIO_STAT_##a) { \
90                         if (i++) \
91                                 printk(" | "); \
92                         printk(#a); \
93                 } \
94         } while (0)
95
96 static void pr_debug_status(u32 status)
97 {
98         int i = 0;
99         pr_debug("status: %08x = ", status);
100         STATUS_TO_TEXT(CARD_REMOVE, status, i);
101         STATUS_TO_TEXT(CARD_INSERT, status, i);
102         STATUS_TO_TEXT(SIGSTATE, status, i);
103         STATUS_TO_TEXT(WRPROTECT, status, i);
104         STATUS_TO_TEXT(CARD_REMOVE_A, status, i);
105         STATUS_TO_TEXT(CARD_INSERT_A, status, i);
106         STATUS_TO_TEXT(SIGSTATE_A, status, i);
107         STATUS_TO_TEXT(CMD_IDX_ERR, status, i);
108         STATUS_TO_TEXT(STOPBIT_ERR, status, i);
109         STATUS_TO_TEXT(ILL_FUNC, status, i);
110         STATUS_TO_TEXT(CMD_BUSY, status, i);
111         STATUS_TO_TEXT(CMDRESPEND, status, i);
112         STATUS_TO_TEXT(DATAEND, status, i);
113         STATUS_TO_TEXT(CRCFAIL, status, i);
114         STATUS_TO_TEXT(DATATIMEOUT, status, i);
115         STATUS_TO_TEXT(CMDTIMEOUT, status, i);
116         STATUS_TO_TEXT(RXOVERFLOW, status, i);
117         STATUS_TO_TEXT(TXUNDERRUN, status, i);
118         STATUS_TO_TEXT(RXRDY, status, i);
119         STATUS_TO_TEXT(TXRQ, status, i);
120         STATUS_TO_TEXT(ILL_ACCESS, status, i);
121         printk("\n");
122 }
123
124 #else
125 #define pr_debug_status(s)  do { } while (0)
126 #endif
127
128 static void tmio_mmc_enable_sdio_irq(struct mmc_host *mmc, int enable)
129 {
130         struct tmio_mmc_host *host = mmc_priv(mmc);
131
132         if (enable && !host->sdio_irq_enabled) {
133                 /* Keep device active while SDIO irq is enabled */
134                 pm_runtime_get_sync(mmc_dev(mmc));
135                 host->sdio_irq_enabled = true;
136
137                 host->sdio_irq_mask = TMIO_SDIO_MASK_ALL &
138                                         ~TMIO_SDIO_STAT_IOIRQ;
139                 sd_ctrl_write16(host, CTL_TRANSACTION_CTL, 0x0001);
140                 sd_ctrl_write16(host, CTL_SDIO_IRQ_MASK, host->sdio_irq_mask);
141         } else if (!enable && host->sdio_irq_enabled) {
142                 host->sdio_irq_mask = TMIO_SDIO_MASK_ALL;
143                 sd_ctrl_write16(host, CTL_SDIO_IRQ_MASK, host->sdio_irq_mask);
144                 sd_ctrl_write16(host, CTL_TRANSACTION_CTL, 0x0000);
145
146                 host->sdio_irq_enabled = false;
147                 pm_runtime_put(mmc_dev(mmc));
148         }
149 }
150
151 static void tmio_mmc_set_clock(struct tmio_mmc_host *host, int new_clock)
152 {
153         u32 clk = 0, clock;
154
155         if (new_clock) {
156                 for (clock = host->mmc->f_min, clk = 0x80000080;
157                         new_clock >= (clock<<1); clk >>= 1)
158                         clock <<= 1;
159                 clk |= 0x100;
160         }
161
162         if (host->set_clk_div)
163                 host->set_clk_div(host->pdev, (clk>>22) & 1);
164
165         sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, clk & 0x1ff);
166         msleep(10);
167 }
168
169 static void tmio_mmc_clk_stop(struct tmio_mmc_host *host)
170 {
171         /* implicit BUG_ON(!res) */
172         if (host->pdata->flags & TMIO_MMC_HAVE_HIGH_REG) {
173                 sd_ctrl_write16(host, CTL_CLK_AND_WAIT_CTL, 0x0000);
174                 msleep(10);
175         }
176
177         sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~0x0100 &
178                 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
179         msleep(10);
180 }
181
182 static void tmio_mmc_clk_start(struct tmio_mmc_host *host)
183 {
184         sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, 0x0100 |
185                 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
186         msleep(10);
187
188         /* implicit BUG_ON(!res) */
189         if (host->pdata->flags & TMIO_MMC_HAVE_HIGH_REG) {
190                 sd_ctrl_write16(host, CTL_CLK_AND_WAIT_CTL, 0x0100);
191                 msleep(10);
192         }
193 }
194
195 static void tmio_mmc_reset(struct tmio_mmc_host *host)
196 {
197         /* FIXME - should we set stop clock reg here */
198         sd_ctrl_write16(host, CTL_RESET_SD, 0x0000);
199         /* implicit BUG_ON(!res) */
200         if (host->pdata->flags & TMIO_MMC_HAVE_HIGH_REG)
201                 sd_ctrl_write16(host, CTL_RESET_SDIO, 0x0000);
202         msleep(10);
203         sd_ctrl_write16(host, CTL_RESET_SD, 0x0001);
204         if (host->pdata->flags & TMIO_MMC_HAVE_HIGH_REG)
205                 sd_ctrl_write16(host, CTL_RESET_SDIO, 0x0001);
206         msleep(10);
207 }
208
209 static void tmio_mmc_reset_work(struct work_struct *work)
210 {
211         struct tmio_mmc_host *host = container_of(work, struct tmio_mmc_host,
212                                                   delayed_reset_work.work);
213         struct mmc_request *mrq;
214         unsigned long flags;
215
216         spin_lock_irqsave(&host->lock, flags);
217         mrq = host->mrq;
218
219         /*
220          * is request already finished? Since we use a non-blocking
221          * cancel_delayed_work(), it can happen, that a .set_ios() call preempts
222          * us, so, have to check for IS_ERR(host->mrq)
223          */
224         if (IS_ERR_OR_NULL(mrq)
225             || time_is_after_jiffies(host->last_req_ts +
226                 msecs_to_jiffies(2000))) {
227                 spin_unlock_irqrestore(&host->lock, flags);
228                 return;
229         }
230
231         dev_warn(&host->pdev->dev,
232                 "timeout waiting for hardware interrupt (CMD%u)\n",
233                 mrq->cmd->opcode);
234
235         if (host->data)
236                 host->data->error = -ETIMEDOUT;
237         else if (host->cmd)
238                 host->cmd->error = -ETIMEDOUT;
239         else
240                 mrq->cmd->error = -ETIMEDOUT;
241
242         host->cmd = NULL;
243         host->data = NULL;
244         host->force_pio = false;
245
246         spin_unlock_irqrestore(&host->lock, flags);
247
248         tmio_mmc_reset(host);
249
250         /* Ready for new calls */
251         host->mrq = NULL;
252
253         tmio_mmc_abort_dma(host);
254         mmc_request_done(host->mmc, mrq);
255 }
256
257 /* called with host->lock held, interrupts disabled */
258 static void tmio_mmc_finish_request(struct tmio_mmc_host *host)
259 {
260         struct mmc_request *mrq;
261         unsigned long flags;
262
263         spin_lock_irqsave(&host->lock, flags);
264
265         mrq = host->mrq;
266         if (IS_ERR_OR_NULL(mrq)) {
267                 spin_unlock_irqrestore(&host->lock, flags);
268                 return;
269         }
270
271         host->cmd = NULL;
272         host->data = NULL;
273         host->force_pio = false;
274
275         cancel_delayed_work(&host->delayed_reset_work);
276
277         host->mrq = NULL;
278         spin_unlock_irqrestore(&host->lock, flags);
279
280         if (mrq->cmd->error || (mrq->data && mrq->data->error))
281                 tmio_mmc_abort_dma(host);
282
283         mmc_request_done(host->mmc, mrq);
284 }
285
286 static void tmio_mmc_done_work(struct work_struct *work)
287 {
288         struct tmio_mmc_host *host = container_of(work, struct tmio_mmc_host,
289                                                   done);
290         tmio_mmc_finish_request(host);
291 }
292
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
306 static int tmio_mmc_start_command(struct tmio_mmc_host *host, struct mmc_command *cmd)
307 {
308         struct mmc_data *data = host->data;
309         int c = cmd->opcode;
310         u32 irq_mask = TMIO_MASK_CMD;
311
312         /* CMD12 is handled by hardware */
313         if (cmd->opcode == MMC_STOP_TRANSMISSION && !cmd->arg) {
314                 sd_ctrl_write16(host, CTL_STOP_INTERNAL_ACTION, 0x001);
315                 return 0;
316         }
317
318         switch (mmc_resp_type(cmd)) {
319         case MMC_RSP_NONE: c |= RESP_NONE; break;
320         case MMC_RSP_R1:   c |= RESP_R1;   break;
321         case MMC_RSP_R1B:  c |= RESP_R1B;  break;
322         case MMC_RSP_R2:   c |= RESP_R2;   break;
323         case MMC_RSP_R3:   c |= RESP_R3;   break;
324         default:
325                 pr_debug("Unknown response type %d\n", mmc_resp_type(cmd));
326                 return -EINVAL;
327         }
328
329         host->cmd = cmd;
330
331 /* FIXME - this seems to be ok commented out but the spec suggest this bit
332  *         should be set when issuing app commands.
333  *      if(cmd->flags & MMC_FLAG_ACMD)
334  *              c |= APP_CMD;
335  */
336         if (data) {
337                 c |= DATA_PRESENT;
338                 if (data->blocks > 1) {
339                         sd_ctrl_write16(host, CTL_STOP_INTERNAL_ACTION, 0x100);
340                         c |= TRANSFER_MULTI;
341                 }
342                 if (data->flags & MMC_DATA_READ)
343                         c |= TRANSFER_READ;
344         }
345
346         if (!host->native_hotplug)
347                 irq_mask &= ~(TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT);
348         tmio_mmc_enable_mmc_irqs(host, irq_mask);
349
350         /* Fire off the command */
351         sd_ctrl_write32(host, CTL_ARG_REG, cmd->arg);
352         sd_ctrl_write16(host, CTL_SD_CMD, c);
353
354         return 0;
355 }
356
357 /*
358  * This chip always returns (at least?) as much data as you ask for.
359  * I'm unsure what happens if you ask for less than a block. This should be
360  * looked into to ensure that a funny length read doesn't hose the controller.
361  */
362 static void tmio_mmc_pio_irq(struct tmio_mmc_host *host)
363 {
364         struct mmc_data *data = host->data;
365         void *sg_virt;
366         unsigned short *buf;
367         unsigned int count;
368         unsigned long flags;
369
370         if ((host->chan_tx || host->chan_rx) && !host->force_pio) {
371                 pr_err("PIO IRQ in DMA mode!\n");
372                 return;
373         } else if (!data) {
374                 pr_debug("Spurious PIO IRQ\n");
375                 return;
376         }
377
378         sg_virt = tmio_mmc_kmap_atomic(host->sg_ptr, &flags);
379         buf = (unsigned short *)(sg_virt + host->sg_off);
380
381         count = host->sg_ptr->length - host->sg_off;
382         if (count > data->blksz)
383                 count = data->blksz;
384
385         pr_debug("count: %08x offset: %08x flags %08x\n",
386                  count, host->sg_off, data->flags);
387
388         /* Transfer the data */
389         if (data->flags & MMC_DATA_READ)
390                 sd_ctrl_read16_rep(host, CTL_SD_DATA_PORT, buf, count >> 1);
391         else
392                 sd_ctrl_write16_rep(host, CTL_SD_DATA_PORT, buf, count >> 1);
393
394         host->sg_off += count;
395
396         tmio_mmc_kunmap_atomic(host->sg_ptr, &flags, sg_virt);
397
398         if (host->sg_off == host->sg_ptr->length)
399                 tmio_mmc_next_sg(host);
400
401         return;
402 }
403
404 static void tmio_mmc_check_bounce_buffer(struct tmio_mmc_host *host)
405 {
406         if (host->sg_ptr == &host->bounce_sg) {
407                 unsigned long flags;
408                 void *sg_vaddr = tmio_mmc_kmap_atomic(host->sg_orig, &flags);
409                 memcpy(sg_vaddr, host->bounce_buf, host->bounce_sg.length);
410                 tmio_mmc_kunmap_atomic(host->sg_orig, &flags, sg_vaddr);
411         }
412 }
413
414 /* needs to be called with host->lock held */
415 void tmio_mmc_do_data_irq(struct tmio_mmc_host *host)
416 {
417         struct mmc_data *data = host->data;
418         struct mmc_command *stop;
419
420         host->data = NULL;
421
422         if (!data) {
423                 dev_warn(&host->pdev->dev, "Spurious data end IRQ\n");
424                 return;
425         }
426         stop = data->stop;
427
428         /* FIXME - return correct transfer count on errors */
429         if (!data->error)
430                 data->bytes_xfered = data->blocks * data->blksz;
431         else
432                 data->bytes_xfered = 0;
433
434         pr_debug("Completed data request\n");
435
436         /*
437          * FIXME: other drivers allow an optional stop command of any given type
438          *        which we dont do, as the chip can auto generate them.
439          *        Perhaps we can be smarter about when to use auto CMD12 and
440          *        only issue the auto request when we know this is the desired
441          *        stop command, allowing fallback to the stop command the
442          *        upper layers expect. For now, we do what works.
443          */
444
445         if (data->flags & MMC_DATA_READ) {
446                 if (host->chan_rx && !host->force_pio)
447                         tmio_mmc_check_bounce_buffer(host);
448                 dev_dbg(&host->pdev->dev, "Complete Rx request %p\n",
449                         host->mrq);
450         } else {
451                 dev_dbg(&host->pdev->dev, "Complete Tx request %p\n",
452                         host->mrq);
453         }
454
455         if (stop) {
456                 if (stop->opcode == MMC_STOP_TRANSMISSION && !stop->arg)
457                         sd_ctrl_write16(host, CTL_STOP_INTERNAL_ACTION, 0x000);
458                 else
459                         BUG();
460         }
461
462         schedule_work(&host->done);
463 }
464
465 static void tmio_mmc_data_irq(struct tmio_mmc_host *host)
466 {
467         struct mmc_data *data;
468         spin_lock(&host->lock);
469         data = host->data;
470
471         if (!data)
472                 goto out;
473
474         if (host->chan_tx && (data->flags & MMC_DATA_WRITE) && !host->force_pio) {
475                 /*
476                  * Has all data been written out yet? Testing on SuperH showed,
477                  * that in most cases the first interrupt comes already with the
478                  * BUSY status bit clear, but on some operations, like mount or
479                  * in the beginning of a write / sync / umount, there is one
480                  * DATAEND interrupt with the BUSY bit set, in this cases
481                  * waiting for one more interrupt fixes the problem.
482                  */
483                 if (!(sd_ctrl_read32(host, CTL_STATUS) & TMIO_STAT_CMD_BUSY)) {
484                         tmio_mmc_disable_mmc_irqs(host, TMIO_STAT_DATAEND);
485                         tasklet_schedule(&host->dma_complete);
486                 }
487         } else if (host->chan_rx && (data->flags & MMC_DATA_READ) && !host->force_pio) {
488                 tmio_mmc_disable_mmc_irqs(host, TMIO_STAT_DATAEND);
489                 tasklet_schedule(&host->dma_complete);
490         } else {
491                 tmio_mmc_do_data_irq(host);
492                 tmio_mmc_disable_mmc_irqs(host, TMIO_MASK_READOP | TMIO_MASK_WRITEOP);
493         }
494 out:
495         spin_unlock(&host->lock);
496 }
497
498 static void tmio_mmc_cmd_irq(struct tmio_mmc_host *host,
499         unsigned int stat)
500 {
501         struct mmc_command *cmd = host->cmd;
502         int i, addr;
503
504         spin_lock(&host->lock);
505
506         if (!host->cmd) {
507                 pr_debug("Spurious CMD irq\n");
508                 goto out;
509         }
510
511         host->cmd = NULL;
512
513         /* This controller is sicker than the PXA one. Not only do we need to
514          * drop the top 8 bits of the first response word, we also need to
515          * modify the order of the response for short response command types.
516          */
517
518         for (i = 3, addr = CTL_RESPONSE ; i >= 0 ; i--, addr += 4)
519                 cmd->resp[i] = sd_ctrl_read32(host, addr);
520
521         if (cmd->flags &  MMC_RSP_136) {
522                 cmd->resp[0] = (cmd->resp[0] << 8) | (cmd->resp[1] >> 24);
523                 cmd->resp[1] = (cmd->resp[1] << 8) | (cmd->resp[2] >> 24);
524                 cmd->resp[2] = (cmd->resp[2] << 8) | (cmd->resp[3] >> 24);
525                 cmd->resp[3] <<= 8;
526         } else if (cmd->flags & MMC_RSP_R3) {
527                 cmd->resp[0] = cmd->resp[3];
528         }
529
530         if (stat & TMIO_STAT_CMDTIMEOUT)
531                 cmd->error = -ETIMEDOUT;
532         else if (stat & TMIO_STAT_CRCFAIL && cmd->flags & MMC_RSP_CRC)
533                 cmd->error = -EILSEQ;
534
535         /* If there is data to handle we enable data IRQs here, and
536          * we will ultimatley finish the request in the data_end handler.
537          * If theres no data or we encountered an error, finish now.
538          */
539         if (host->data && !cmd->error) {
540                 if (host->data->flags & MMC_DATA_READ) {
541                         if (host->force_pio || !host->chan_rx)
542                                 tmio_mmc_enable_mmc_irqs(host, TMIO_MASK_READOP);
543                         else
544                                 tasklet_schedule(&host->dma_issue);
545                 } else {
546                         if (host->force_pio || !host->chan_tx)
547                                 tmio_mmc_enable_mmc_irqs(host, TMIO_MASK_WRITEOP);
548                         else
549                                 tasklet_schedule(&host->dma_issue);
550                 }
551         } else {
552                 schedule_work(&host->done);
553         }
554
555 out:
556         spin_unlock(&host->lock);
557 }
558
559 static void tmio_mmc_card_irq_status(struct tmio_mmc_host *host,
560                                        int *ireg, int *status)
561 {
562         *status = sd_ctrl_read32(host, CTL_STATUS);
563         *ireg = *status & TMIO_MASK_IRQ & ~host->sdcard_irq_mask;
564
565         pr_debug_status(*status);
566         pr_debug_status(*ireg);
567 }
568
569 static bool __tmio_mmc_card_detect_irq(struct tmio_mmc_host *host,
570                                       int ireg, int status)
571 {
572         struct mmc_host *mmc = host->mmc;
573
574         /* Card insert / remove attempts */
575         if (ireg & (TMIO_STAT_CARD_INSERT | TMIO_STAT_CARD_REMOVE)) {
576                 tmio_mmc_ack_mmc_irqs(host, TMIO_STAT_CARD_INSERT |
577                         TMIO_STAT_CARD_REMOVE);
578                 if ((((ireg & TMIO_STAT_CARD_REMOVE) && mmc->card) ||
579                      ((ireg & TMIO_STAT_CARD_INSERT) && !mmc->card)) &&
580                     !work_pending(&mmc->detect.work))
581                         mmc_detect_change(host->mmc, msecs_to_jiffies(100));
582                 return true;
583         }
584
585         return false;
586 }
587
588 irqreturn_t tmio_mmc_card_detect_irq(int irq, void *devid)
589 {
590         unsigned int ireg, status;
591         struct tmio_mmc_host *host = devid;
592
593         tmio_mmc_card_irq_status(host, &ireg, &status);
594         __tmio_mmc_card_detect_irq(host, ireg, status);
595
596         return IRQ_HANDLED;
597 }
598 EXPORT_SYMBOL(tmio_mmc_card_detect_irq);
599
600 static bool __tmio_mmc_sdcard_irq(struct tmio_mmc_host *host,
601                                  int ireg, int status)
602 {
603         /* Command completion */
604         if (ireg & (TMIO_STAT_CMDRESPEND | TMIO_STAT_CMDTIMEOUT)) {
605                 tmio_mmc_ack_mmc_irqs(host,
606                              TMIO_STAT_CMDRESPEND |
607                              TMIO_STAT_CMDTIMEOUT);
608                 tmio_mmc_cmd_irq(host, status);
609                 return true;
610         }
611
612         /* Data transfer */
613         if (ireg & (TMIO_STAT_RXRDY | TMIO_STAT_TXRQ)) {
614                 tmio_mmc_ack_mmc_irqs(host, TMIO_STAT_RXRDY | TMIO_STAT_TXRQ);
615                 tmio_mmc_pio_irq(host);
616                 return true;
617         }
618
619         /* Data transfer completion */
620         if (ireg & TMIO_STAT_DATAEND) {
621                 tmio_mmc_ack_mmc_irqs(host, TMIO_STAT_DATAEND);
622                 tmio_mmc_data_irq(host);
623                 return true;
624         }
625
626         return false;
627 }
628
629 irqreturn_t tmio_mmc_sdcard_irq(int irq, void *devid)
630 {
631         unsigned int ireg, status;
632         struct tmio_mmc_host *host = devid;
633
634         tmio_mmc_card_irq_status(host, &ireg, &status);
635         __tmio_mmc_sdcard_irq(host, ireg, status);
636
637         return IRQ_HANDLED;
638 }
639 EXPORT_SYMBOL(tmio_mmc_sdcard_irq);
640
641 irqreturn_t tmio_mmc_sdio_irq(int irq, void *devid)
642 {
643         struct tmio_mmc_host *host = devid;
644         struct mmc_host *mmc = host->mmc;
645         struct tmio_mmc_data *pdata = host->pdata;
646         unsigned int ireg, status;
647
648         if (!(pdata->flags & TMIO_MMC_SDIO_IRQ))
649                 return IRQ_HANDLED;
650
651         status = sd_ctrl_read16(host, CTL_SDIO_STATUS);
652         ireg = status & TMIO_SDIO_MASK_ALL & ~host->sdcard_irq_mask;
653
654         sd_ctrl_write16(host, CTL_SDIO_STATUS, status & ~TMIO_SDIO_MASK_ALL);
655
656         if (mmc->caps & MMC_CAP_SDIO_IRQ && ireg & TMIO_SDIO_STAT_IOIRQ)
657                 mmc_signal_sdio_irq(mmc);
658
659         return IRQ_HANDLED;
660 }
661 EXPORT_SYMBOL(tmio_mmc_sdio_irq);
662
663 irqreturn_t tmio_mmc_irq(int irq, void *devid)
664 {
665         struct tmio_mmc_host *host = devid;
666         unsigned int ireg, status;
667
668         pr_debug("MMC IRQ begin\n");
669
670         tmio_mmc_card_irq_status(host, &ireg, &status);
671         if (__tmio_mmc_card_detect_irq(host, ireg, status))
672                 return IRQ_HANDLED;
673         if (__tmio_mmc_sdcard_irq(host, ireg, status))
674                 return IRQ_HANDLED;
675
676         tmio_mmc_sdio_irq(irq, devid);
677
678         return IRQ_HANDLED;
679 }
680 EXPORT_SYMBOL(tmio_mmc_irq);
681
682 static int tmio_mmc_start_data(struct tmio_mmc_host *host,
683         struct mmc_data *data)
684 {
685         struct tmio_mmc_data *pdata = host->pdata;
686
687         pr_debug("setup data transfer: blocksize %08x  nr_blocks %d\n",
688                  data->blksz, data->blocks);
689
690         /* Some hardware cannot perform 2 byte requests in 4 bit mode */
691         if (host->mmc->ios.bus_width == MMC_BUS_WIDTH_4) {
692                 int blksz_2bytes = pdata->flags & TMIO_MMC_BLKSZ_2BYTES;
693
694                 if (data->blksz < 2 || (data->blksz < 4 && !blksz_2bytes)) {
695                         pr_err("%s: %d byte block unsupported in 4 bit mode\n",
696                                mmc_hostname(host->mmc), data->blksz);
697                         return -EINVAL;
698                 }
699         }
700
701         tmio_mmc_init_sg(host, data);
702         host->data = data;
703
704         /* Set transfer length / blocksize */
705         sd_ctrl_write16(host, CTL_SD_XFER_LEN, data->blksz);
706         sd_ctrl_write16(host, CTL_XFER_BLK_COUNT, data->blocks);
707
708         tmio_mmc_start_dma(host, data);
709
710         return 0;
711 }
712
713 /* Process requests from the MMC layer */
714 static void tmio_mmc_request(struct mmc_host *mmc, struct mmc_request *mrq)
715 {
716         struct tmio_mmc_host *host = mmc_priv(mmc);
717         unsigned long flags;
718         int ret;
719
720         spin_lock_irqsave(&host->lock, flags);
721
722         if (host->mrq) {
723                 pr_debug("request not null\n");
724                 if (IS_ERR(host->mrq)) {
725                         spin_unlock_irqrestore(&host->lock, flags);
726                         mrq->cmd->error = -EAGAIN;
727                         mmc_request_done(mmc, mrq);
728                         return;
729                 }
730         }
731
732         host->last_req_ts = jiffies;
733         wmb();
734         host->mrq = mrq;
735
736         spin_unlock_irqrestore(&host->lock, flags);
737
738         if (mrq->data) {
739                 ret = tmio_mmc_start_data(host, mrq->data);
740                 if (ret)
741                         goto fail;
742         }
743
744         ret = tmio_mmc_start_command(host, mrq->cmd);
745         if (!ret) {
746                 schedule_delayed_work(&host->delayed_reset_work,
747                                       msecs_to_jiffies(2000));
748                 return;
749         }
750
751 fail:
752         host->force_pio = false;
753         host->mrq = NULL;
754         mrq->cmd->error = ret;
755         mmc_request_done(mmc, mrq);
756 }
757
758 static int tmio_mmc_clk_update(struct mmc_host *mmc)
759 {
760         struct tmio_mmc_host *host = mmc_priv(mmc);
761         struct tmio_mmc_data *pdata = host->pdata;
762         int ret;
763
764         if (!pdata->clk_enable)
765                 return -ENOTSUPP;
766
767         ret = pdata->clk_enable(host->pdev, &mmc->f_max);
768         if (!ret)
769                 mmc->f_min = mmc->f_max / 512;
770
771         return ret;
772 }
773
774 static void tmio_mmc_power_on(struct tmio_mmc_host *host, unsigned short vdd)
775 {
776         struct mmc_host *mmc = host->mmc;
777         int ret = 0;
778
779         /* .set_ios() is returning void, so, no chance to report an error */
780
781         if (host->set_pwr)
782                 host->set_pwr(host->pdev, 1);
783
784         if (!IS_ERR(mmc->supply.vmmc)) {
785                 ret = mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd);
786                 /*
787                  * Attention: empiric value. With a b43 WiFi SDIO card this
788                  * delay proved necessary for reliable card-insertion probing.
789                  * 100us were not enough. Is this the same 140us delay, as in
790                  * tmio_mmc_set_ios()?
791                  */
792                 udelay(200);
793         }
794         /*
795          * It seems, VccQ should be switched on after Vcc, this is also what the
796          * omap_hsmmc.c driver does.
797          */
798         if (!IS_ERR(mmc->supply.vqmmc) && !ret) {
799                 ret = regulator_enable(mmc->supply.vqmmc);
800                 udelay(200);
801         }
802
803         if (ret < 0)
804                 dev_dbg(&host->pdev->dev, "Regulators failed to power up: %d\n",
805                         ret);
806 }
807
808 static void tmio_mmc_power_off(struct tmio_mmc_host *host)
809 {
810         struct mmc_host *mmc = host->mmc;
811
812         if (!IS_ERR(mmc->supply.vqmmc))
813                 regulator_disable(mmc->supply.vqmmc);
814
815         if (!IS_ERR(mmc->supply.vmmc))
816                 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, 0);
817
818         if (host->set_pwr)
819                 host->set_pwr(host->pdev, 0);
820 }
821
822 /* Set MMC clock / power.
823  * Note: This controller uses a simple divider scheme therefore it cannot
824  * run a MMC card at full speed (20MHz). The max clock is 24MHz on SD, but as
825  * MMC wont run that fast, it has to be clocked at 12MHz which is the next
826  * slowest setting.
827  */
828 static void tmio_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
829 {
830         struct tmio_mmc_host *host = mmc_priv(mmc);
831         struct device *dev = &host->pdev->dev;
832         unsigned long flags;
833
834         mutex_lock(&host->ios_lock);
835
836         spin_lock_irqsave(&host->lock, flags);
837         if (host->mrq) {
838                 if (IS_ERR(host->mrq)) {
839                         dev_dbg(dev,
840                                 "%s.%d: concurrent .set_ios(), clk %u, mode %u\n",
841                                 current->comm, task_pid_nr(current),
842                                 ios->clock, ios->power_mode);
843                         host->mrq = ERR_PTR(-EINTR);
844                 } else {
845                         dev_dbg(dev,
846                                 "%s.%d: CMD%u active since %lu, now %lu!\n",
847                                 current->comm, task_pid_nr(current),
848                                 host->mrq->cmd->opcode, host->last_req_ts, jiffies);
849                 }
850                 spin_unlock_irqrestore(&host->lock, flags);
851
852                 mutex_unlock(&host->ios_lock);
853                 return;
854         }
855
856         host->mrq = ERR_PTR(-EBUSY);
857
858         spin_unlock_irqrestore(&host->lock, flags);
859
860         /*
861          * host->power toggles between false and true in both cases - either
862          * or not the controller can be runtime-suspended during inactivity.
863          * But if the controller has to be kept on, the runtime-pm usage_count
864          * is kept positive, so no suspending actually takes place.
865          */
866         if (ios->power_mode == MMC_POWER_ON && ios->clock) {
867                 if (host->power != TMIO_MMC_ON_RUN) {
868                         tmio_mmc_clk_update(mmc);
869                         pm_runtime_get_sync(dev);
870                         if (host->resuming) {
871                                 tmio_mmc_reset(host);
872                                 host->resuming = false;
873                         }
874                 }
875                 if (host->power == TMIO_MMC_OFF_STOP)
876                         tmio_mmc_reset(host);
877                 tmio_mmc_set_clock(host, ios->clock);
878                 if (host->power == TMIO_MMC_OFF_STOP)
879                         /* power up SD card and the bus */
880                         tmio_mmc_power_on(host, ios->vdd);
881                 host->power = TMIO_MMC_ON_RUN;
882                 /* start bus clock */
883                 tmio_mmc_clk_start(host);
884         } else if (ios->power_mode != MMC_POWER_UP) {
885                 struct tmio_mmc_data *pdata = host->pdata;
886                 unsigned int old_power = host->power;
887
888                 if (old_power != TMIO_MMC_OFF_STOP) {
889                         if (ios->power_mode == MMC_POWER_OFF) {
890                                 tmio_mmc_power_off(host);
891                                 host->power = TMIO_MMC_OFF_STOP;
892                         } else {
893                                 host->power = TMIO_MMC_ON_STOP;
894                         }
895                 }
896
897                 if (old_power == TMIO_MMC_ON_RUN) {
898                         tmio_mmc_clk_stop(host);
899                         pm_runtime_put(dev);
900                         if (pdata->clk_disable)
901                                 pdata->clk_disable(host->pdev);
902                 }
903         }
904
905         if (host->power != TMIO_MMC_OFF_STOP) {
906                 switch (ios->bus_width) {
907                 case MMC_BUS_WIDTH_1:
908                         sd_ctrl_write16(host, CTL_SD_MEM_CARD_OPT, 0x80e0);
909                 break;
910                 case MMC_BUS_WIDTH_4:
911                         sd_ctrl_write16(host, CTL_SD_MEM_CARD_OPT, 0x00e0);
912                 break;
913                 }
914         }
915
916         /* Let things settle. delay taken from winCE driver */
917         udelay(140);
918         if (PTR_ERR(host->mrq) == -EINTR)
919                 dev_dbg(&host->pdev->dev,
920                         "%s.%d: IOS interrupted: clk %u, mode %u",
921                         current->comm, task_pid_nr(current),
922                         ios->clock, ios->power_mode);
923         host->mrq = NULL;
924
925         mutex_unlock(&host->ios_lock);
926 }
927
928 static int tmio_mmc_get_ro(struct mmc_host *mmc)
929 {
930         struct tmio_mmc_host *host = mmc_priv(mmc);
931         struct tmio_mmc_data *pdata = host->pdata;
932         int ret = mmc_gpio_get_ro(mmc);
933         if (ret >= 0)
934                 return ret;
935
936         return !((pdata->flags & TMIO_MMC_WRPROTECT_DISABLE) ||
937                  (sd_ctrl_read32(host, CTL_STATUS) & TMIO_STAT_WRPROTECT));
938 }
939
940 static const struct mmc_host_ops tmio_mmc_ops = {
941         .request        = tmio_mmc_request,
942         .set_ios        = tmio_mmc_set_ios,
943         .get_ro         = tmio_mmc_get_ro,
944         .get_cd         = mmc_gpio_get_cd,
945         .enable_sdio_irq = tmio_mmc_enable_sdio_irq,
946 };
947
948 static int tmio_mmc_init_ocr(struct tmio_mmc_host *host)
949 {
950         struct tmio_mmc_data *pdata = host->pdata;
951         struct mmc_host *mmc = host->mmc;
952
953         mmc_regulator_get_supply(mmc);
954
955         /* use ocr_mask if no regulator */
956         if (!mmc->ocr_avail)
957                 mmc->ocr_avail =  pdata->ocr_mask;
958
959         /*
960          * try again.
961          * There is possibility that regulator has not been probed
962          */
963         if (!mmc->ocr_avail)
964                 return -EPROBE_DEFER;
965
966         return 0;
967 }
968
969 static void tmio_mmc_of_parse(struct platform_device *pdev,
970                               struct tmio_mmc_data *pdata)
971 {
972         const struct device_node *np = pdev->dev.of_node;
973         if (!np)
974                 return;
975
976         if (of_get_property(np, "toshiba,mmc-wrprotect-disable", NULL))
977                 pdata->flags |= TMIO_MMC_WRPROTECT_DISABLE;
978 }
979
980 int tmio_mmc_host_probe(struct tmio_mmc_host **host,
981                                   struct platform_device *pdev,
982                                   struct tmio_mmc_data *pdata)
983 {
984         struct tmio_mmc_host *_host;
985         struct mmc_host *mmc;
986         struct resource *res_ctl;
987         int ret;
988         u32 irq_mask = TMIO_MASK_CMD;
989
990         tmio_mmc_of_parse(pdev, pdata);
991
992         if (!(pdata->flags & TMIO_MMC_HAS_IDLE_WAIT))
993                 pdata->write16_hook = NULL;
994
995         res_ctl = platform_get_resource(pdev, IORESOURCE_MEM, 0);
996         if (!res_ctl)
997                 return -EINVAL;
998
999         mmc = mmc_alloc_host(sizeof(struct tmio_mmc_host), &pdev->dev);
1000         if (!mmc)
1001                 return -ENOMEM;
1002
1003         ret = mmc_of_parse(mmc);
1004         if (ret < 0)
1005                 goto host_free;
1006
1007         pdata->dev = &pdev->dev;
1008         _host = mmc_priv(mmc);
1009         _host->pdata = pdata;
1010         _host->mmc = mmc;
1011         _host->pdev = pdev;
1012         platform_set_drvdata(pdev, mmc);
1013
1014         _host->set_pwr = pdata->set_pwr;
1015         _host->set_clk_div = pdata->set_clk_div;
1016
1017         ret = tmio_mmc_init_ocr(_host);
1018         if (ret < 0)
1019                 goto host_free;
1020
1021         _host->ctl = ioremap(res_ctl->start, resource_size(res_ctl));
1022         if (!_host->ctl) {
1023                 ret = -ENOMEM;
1024                 goto host_free;
1025         }
1026
1027         mmc->ops = &tmio_mmc_ops;
1028         mmc->caps |= MMC_CAP_4_BIT_DATA | pdata->capabilities;
1029         mmc->caps2 |= pdata->capabilities2;
1030         mmc->max_segs = 32;
1031         mmc->max_blk_size = 512;
1032         mmc->max_blk_count = (PAGE_CACHE_SIZE / mmc->max_blk_size) *
1033                 mmc->max_segs;
1034         mmc->max_req_size = mmc->max_blk_size * mmc->max_blk_count;
1035         mmc->max_seg_size = mmc->max_req_size;
1036
1037         _host->native_hotplug = !(pdata->flags & TMIO_MMC_USE_GPIO_CD ||
1038                                   mmc->caps & MMC_CAP_NEEDS_POLL ||
1039                                   mmc->caps & MMC_CAP_NONREMOVABLE ||
1040                                   mmc->slot.cd_irq >= 0);
1041
1042         _host->power = TMIO_MMC_OFF_STOP;
1043         pm_runtime_enable(&pdev->dev);
1044         ret = pm_runtime_resume(&pdev->dev);
1045         if (ret < 0)
1046                 goto pm_disable;
1047
1048         if (tmio_mmc_clk_update(mmc) < 0) {
1049                 mmc->f_max = pdata->hclk;
1050                 mmc->f_min = mmc->f_max / 512;
1051         }
1052
1053         /*
1054          * There are 4 different scenarios for the card detection:
1055          *  1) an external gpio irq handles the cd (best for power savings)
1056          *  2) internal sdhi irq handles the cd
1057          *  3) a worker thread polls the sdhi - indicated by MMC_CAP_NEEDS_POLL
1058          *  4) the medium is non-removable - indicated by MMC_CAP_NONREMOVABLE
1059          *
1060          *  While we increment the runtime PM counter for all scenarios when
1061          *  the mmc core activates us by calling an appropriate set_ios(), we
1062          *  must additionally ensure that in case 2) the tmio mmc hardware stays
1063          *  powered on during runtime for the card detection to work.
1064          */
1065         if (_host->native_hotplug)
1066                 pm_runtime_get_noresume(&pdev->dev);
1067
1068         tmio_mmc_clk_stop(_host);
1069         tmio_mmc_reset(_host);
1070
1071         _host->sdcard_irq_mask = sd_ctrl_read32(_host, CTL_IRQ_MASK);
1072         tmio_mmc_disable_mmc_irqs(_host, TMIO_MASK_ALL);
1073
1074         /* Unmask the IRQs we want to know about */
1075         if (!_host->chan_rx)
1076                 irq_mask |= TMIO_MASK_READOP;
1077         if (!_host->chan_tx)
1078                 irq_mask |= TMIO_MASK_WRITEOP;
1079         if (!_host->native_hotplug)
1080                 irq_mask &= ~(TMIO_STAT_CARD_REMOVE | TMIO_STAT_CARD_INSERT);
1081
1082         _host->sdcard_irq_mask &= ~irq_mask;
1083
1084         _host->sdio_irq_enabled = false;
1085         if (pdata->flags & TMIO_MMC_SDIO_IRQ) {
1086                 _host->sdio_irq_mask = TMIO_SDIO_MASK_ALL;
1087                 sd_ctrl_write16(_host, CTL_SDIO_IRQ_MASK, _host->sdio_irq_mask);
1088                 sd_ctrl_write16(_host, CTL_TRANSACTION_CTL, 0x0000);
1089         }
1090
1091         spin_lock_init(&_host->lock);
1092         mutex_init(&_host->ios_lock);
1093
1094         /* Init delayed work for request timeouts */
1095         INIT_DELAYED_WORK(&_host->delayed_reset_work, tmio_mmc_reset_work);
1096         INIT_WORK(&_host->done, tmio_mmc_done_work);
1097
1098         /* See if we also get DMA */
1099         tmio_mmc_request_dma(_host, pdata);
1100
1101         ret = mmc_add_host(mmc);
1102         if (pdata->clk_disable)
1103                 pdata->clk_disable(pdev);
1104         if (ret < 0) {
1105                 tmio_mmc_host_remove(_host);
1106                 return ret;
1107         }
1108
1109         dev_pm_qos_expose_latency_limit(&pdev->dev, 100);
1110
1111         if (pdata->flags & TMIO_MMC_USE_GPIO_CD) {
1112                 ret = mmc_gpio_request_cd(mmc, pdata->cd_gpio, 0);
1113                 if (ret < 0) {
1114                         tmio_mmc_host_remove(_host);
1115                         return ret;
1116                 }
1117         }
1118
1119         *host = _host;
1120
1121         return 0;
1122
1123 pm_disable:
1124         pm_runtime_disable(&pdev->dev);
1125         iounmap(_host->ctl);
1126 host_free:
1127         mmc_free_host(mmc);
1128
1129         return ret;
1130 }
1131 EXPORT_SYMBOL(tmio_mmc_host_probe);
1132
1133 void tmio_mmc_host_remove(struct tmio_mmc_host *host)
1134 {
1135         struct platform_device *pdev = host->pdev;
1136         struct mmc_host *mmc = host->mmc;
1137
1138         if (!host->native_hotplug)
1139                 pm_runtime_get_sync(&pdev->dev);
1140
1141         dev_pm_qos_hide_latency_limit(&pdev->dev);
1142
1143         mmc_remove_host(mmc);
1144         cancel_work_sync(&host->done);
1145         cancel_delayed_work_sync(&host->delayed_reset_work);
1146         tmio_mmc_release_dma(host);
1147
1148         pm_runtime_put_sync(&pdev->dev);
1149         pm_runtime_disable(&pdev->dev);
1150
1151         iounmap(host->ctl);
1152         mmc_free_host(mmc);
1153 }
1154 EXPORT_SYMBOL(tmio_mmc_host_remove);
1155
1156 #ifdef CONFIG_PM_SLEEP
1157 int tmio_mmc_host_suspend(struct device *dev)
1158 {
1159         struct mmc_host *mmc = dev_get_drvdata(dev);
1160         struct tmio_mmc_host *host = mmc_priv(mmc);
1161
1162         tmio_mmc_disable_mmc_irqs(host, TMIO_MASK_ALL);
1163         return 0;
1164 }
1165 EXPORT_SYMBOL(tmio_mmc_host_suspend);
1166
1167 int tmio_mmc_host_resume(struct device *dev)
1168 {
1169         struct mmc_host *mmc = dev_get_drvdata(dev);
1170         struct tmio_mmc_host *host = mmc_priv(mmc);
1171
1172         tmio_mmc_enable_dma(host, true);
1173
1174         /* The MMC core will perform the complete set up */
1175         host->resuming = true;
1176         return 0;
1177 }
1178 EXPORT_SYMBOL(tmio_mmc_host_resume);
1179 #endif
1180
1181 #ifdef CONFIG_PM_RUNTIME
1182 int tmio_mmc_host_runtime_suspend(struct device *dev)
1183 {
1184         return 0;
1185 }
1186 EXPORT_SYMBOL(tmio_mmc_host_runtime_suspend);
1187
1188 int tmio_mmc_host_runtime_resume(struct device *dev)
1189 {
1190         struct mmc_host *mmc = dev_get_drvdata(dev);
1191         struct tmio_mmc_host *host = mmc_priv(mmc);
1192
1193         tmio_mmc_enable_dma(host, true);
1194
1195         return 0;
1196 }
1197 EXPORT_SYMBOL(tmio_mmc_host_runtime_resume);
1198 #endif
1199
1200 MODULE_LICENSE("GPL v2");