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