Linux Audio

Check our new training course

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