2 * linux/drivers/mmc/sdhci.c - Secure Digital Host Controller Interface driver
4 * Copyright (C) 2005-2006 Pierre Ossman, All Rights Reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or (at
9 * your option) any later version.
12 #include <linux/delay.h>
13 #include <linux/highmem.h>
14 #include <linux/pci.h>
15 #include <linux/dma-mapping.h>
17 #include <linux/mmc/host.h>
18 #include <linux/mmc/protocol.h>
20 #include <asm/scatterlist.h>
24 #define DRIVER_NAME "sdhci"
26 #define BUGMAIL "<sdhci-devel@list.drzeus.cx>"
28 #define DBG(f, x...) \
29 pr_debug(DRIVER_NAME " [%s()]: " f, __func__,## x)
31 static unsigned int debug_nodma = 0;
32 static unsigned int debug_forcedma = 0;
33 static unsigned int debug_quirks = 0;
35 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
36 #define SDHCI_QUIRK_FORCE_DMA (1<<1)
37 /* Controller doesn't like some resets when there is no card inserted. */
38 #define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
39 #define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
41 static const struct pci_device_id pci_ids[] __devinitdata = {
43 .vendor = PCI_VENDOR_ID_RICOH,
44 .device = PCI_DEVICE_ID_RICOH_R5C822,
45 .subvendor = PCI_VENDOR_ID_IBM,
46 .subdevice = PCI_ANY_ID,
47 .driver_data = SDHCI_QUIRK_CLOCK_BEFORE_RESET |
48 SDHCI_QUIRK_FORCE_DMA,
52 .vendor = PCI_VENDOR_ID_RICOH,
53 .device = PCI_DEVICE_ID_RICOH_R5C822,
54 .subvendor = PCI_ANY_ID,
55 .subdevice = PCI_ANY_ID,
56 .driver_data = SDHCI_QUIRK_FORCE_DMA |
57 SDHCI_QUIRK_NO_CARD_NO_RESET,
61 .vendor = PCI_VENDOR_ID_TI,
62 .device = PCI_DEVICE_ID_TI_XX21_XX11_SD,
63 .subvendor = PCI_ANY_ID,
64 .subdevice = PCI_ANY_ID,
65 .driver_data = SDHCI_QUIRK_FORCE_DMA,
69 .vendor = PCI_VENDOR_ID_ENE,
70 .device = PCI_DEVICE_ID_ENE_CB712_SD,
71 .subvendor = PCI_ANY_ID,
72 .subdevice = PCI_ANY_ID,
73 .driver_data = SDHCI_QUIRK_SINGLE_POWER_WRITE,
76 { /* Generic SD host controller */
77 PCI_DEVICE_CLASS((PCI_CLASS_SYSTEM_SDHCI << 8), 0xFFFF00)
80 { /* end: all zeroes */ },
83 MODULE_DEVICE_TABLE(pci, pci_ids);
85 static void sdhci_prepare_data(struct sdhci_host *, struct mmc_data *);
86 static void sdhci_finish_data(struct sdhci_host *);
88 static void sdhci_send_command(struct sdhci_host *, struct mmc_command *);
89 static void sdhci_finish_command(struct sdhci_host *);
91 static void sdhci_dumpregs(struct sdhci_host *host)
93 printk(KERN_DEBUG DRIVER_NAME ": ============== REGISTER DUMP ==============\n");
95 printk(KERN_DEBUG DRIVER_NAME ": Sys addr: 0x%08x | Version: 0x%08x\n",
96 readl(host->ioaddr + SDHCI_DMA_ADDRESS),
97 readw(host->ioaddr + SDHCI_HOST_VERSION));
98 printk(KERN_DEBUG DRIVER_NAME ": Blk size: 0x%08x | Blk cnt: 0x%08x\n",
99 readw(host->ioaddr + SDHCI_BLOCK_SIZE),
100 readw(host->ioaddr + SDHCI_BLOCK_COUNT));
101 printk(KERN_DEBUG DRIVER_NAME ": Argument: 0x%08x | Trn mode: 0x%08x\n",
102 readl(host->ioaddr + SDHCI_ARGUMENT),
103 readw(host->ioaddr + SDHCI_TRANSFER_MODE));
104 printk(KERN_DEBUG DRIVER_NAME ": Present: 0x%08x | Host ctl: 0x%08x\n",
105 readl(host->ioaddr + SDHCI_PRESENT_STATE),
106 readb(host->ioaddr + SDHCI_HOST_CONTROL));
107 printk(KERN_DEBUG DRIVER_NAME ": Power: 0x%08x | Blk gap: 0x%08x\n",
108 readb(host->ioaddr + SDHCI_POWER_CONTROL),
109 readb(host->ioaddr + SDHCI_BLOCK_GAP_CONTROL));
110 printk(KERN_DEBUG DRIVER_NAME ": Wake-up: 0x%08x | Clock: 0x%08x\n",
111 readb(host->ioaddr + SDHCI_WALK_UP_CONTROL),
112 readw(host->ioaddr + SDHCI_CLOCK_CONTROL));
113 printk(KERN_DEBUG DRIVER_NAME ": Timeout: 0x%08x | Int stat: 0x%08x\n",
114 readb(host->ioaddr + SDHCI_TIMEOUT_CONTROL),
115 readl(host->ioaddr + SDHCI_INT_STATUS));
116 printk(KERN_DEBUG DRIVER_NAME ": Int enab: 0x%08x | Sig enab: 0x%08x\n",
117 readl(host->ioaddr + SDHCI_INT_ENABLE),
118 readl(host->ioaddr + SDHCI_SIGNAL_ENABLE));
119 printk(KERN_DEBUG DRIVER_NAME ": AC12 err: 0x%08x | Slot int: 0x%08x\n",
120 readw(host->ioaddr + SDHCI_ACMD12_ERR),
121 readw(host->ioaddr + SDHCI_SLOT_INT_STATUS));
122 printk(KERN_DEBUG DRIVER_NAME ": Caps: 0x%08x | Max curr: 0x%08x\n",
123 readl(host->ioaddr + SDHCI_CAPABILITIES),
124 readl(host->ioaddr + SDHCI_MAX_CURRENT));
126 printk(KERN_DEBUG DRIVER_NAME ": ===========================================\n");
129 /*****************************************************************************\
131 * Low level functions *
133 \*****************************************************************************/
135 static void sdhci_reset(struct sdhci_host *host, u8 mask)
137 unsigned long timeout;
139 if (host->chip->quirks & SDHCI_QUIRK_NO_CARD_NO_RESET) {
140 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) &
145 writeb(mask, host->ioaddr + SDHCI_SOFTWARE_RESET);
147 if (mask & SDHCI_RESET_ALL)
150 /* Wait max 100 ms */
153 /* hw clears the bit when it's done */
154 while (readb(host->ioaddr + SDHCI_SOFTWARE_RESET) & mask) {
156 printk(KERN_ERR "%s: Reset 0x%x never completed. "
157 "Please report this to " BUGMAIL ".\n",
158 mmc_hostname(host->mmc), (int)mask);
159 sdhci_dumpregs(host);
167 static void sdhci_init(struct sdhci_host *host)
171 sdhci_reset(host, SDHCI_RESET_ALL);
173 intmask = SDHCI_INT_BUS_POWER | SDHCI_INT_DATA_END_BIT |
174 SDHCI_INT_DATA_CRC | SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_INDEX |
175 SDHCI_INT_END_BIT | SDHCI_INT_CRC | SDHCI_INT_TIMEOUT |
176 SDHCI_INT_CARD_REMOVE | SDHCI_INT_CARD_INSERT |
177 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL |
178 SDHCI_INT_DMA_END | SDHCI_INT_DATA_END | SDHCI_INT_RESPONSE;
180 writel(intmask, host->ioaddr + SDHCI_INT_ENABLE);
181 writel(intmask, host->ioaddr + SDHCI_SIGNAL_ENABLE);
184 static void sdhci_activate_led(struct sdhci_host *host)
188 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
189 ctrl |= SDHCI_CTRL_LED;
190 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
193 static void sdhci_deactivate_led(struct sdhci_host *host)
197 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
198 ctrl &= ~SDHCI_CTRL_LED;
199 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
202 /*****************************************************************************\
206 \*****************************************************************************/
208 static inline char* sdhci_sg_to_buffer(struct sdhci_host* host)
210 return page_address(host->cur_sg->page) + host->cur_sg->offset;
213 static inline int sdhci_next_sg(struct sdhci_host* host)
216 * Skip to next SG entry.
224 if (host->num_sg > 0) {
226 host->remain = host->cur_sg->length;
232 static void sdhci_read_block_pio(struct sdhci_host *host)
234 int blksize, chunk_remain;
239 DBG("PIO reading\n");
241 blksize = host->data->blksz;
245 buffer = sdhci_sg_to_buffer(host) + host->offset;
248 if (chunk_remain == 0) {
249 data = readl(host->ioaddr + SDHCI_BUFFER);
250 chunk_remain = min(blksize, 4);
253 size = min(host->size, host->remain);
254 size = min(size, chunk_remain);
256 chunk_remain -= size;
258 host->offset += size;
259 host->remain -= size;
262 *buffer = data & 0xFF;
268 if (host->remain == 0) {
269 if (sdhci_next_sg(host) == 0) {
270 BUG_ON(blksize != 0);
273 buffer = sdhci_sg_to_buffer(host);
278 static void sdhci_write_block_pio(struct sdhci_host *host)
280 int blksize, chunk_remain;
285 DBG("PIO writing\n");
287 blksize = host->data->blksz;
292 buffer = sdhci_sg_to_buffer(host) + host->offset;
295 size = min(host->size, host->remain);
296 size = min(size, chunk_remain);
298 chunk_remain -= size;
300 host->offset += size;
301 host->remain -= size;
305 data |= (u32)*buffer << 24;
310 if (chunk_remain == 0) {
311 writel(data, host->ioaddr + SDHCI_BUFFER);
312 chunk_remain = min(blksize, 4);
315 if (host->remain == 0) {
316 if (sdhci_next_sg(host) == 0) {
317 BUG_ON(blksize != 0);
320 buffer = sdhci_sg_to_buffer(host);
325 static void sdhci_transfer_pio(struct sdhci_host *host)
334 if (host->data->flags & MMC_DATA_READ)
335 mask = SDHCI_DATA_AVAILABLE;
337 mask = SDHCI_SPACE_AVAILABLE;
339 while (readl(host->ioaddr + SDHCI_PRESENT_STATE) & mask) {
340 if (host->data->flags & MMC_DATA_READ)
341 sdhci_read_block_pio(host);
343 sdhci_write_block_pio(host);
348 BUG_ON(host->num_sg == 0);
351 DBG("PIO transfer complete.\n");
354 static void sdhci_prepare_data(struct sdhci_host *host, struct mmc_data *data)
357 unsigned target_timeout, current_timeout;
364 DBG("blksz %04x blks %04x flags %08x\n",
365 data->blksz, data->blocks, data->flags);
366 DBG("tsac %d ms nsac %d clk\n",
367 data->timeout_ns / 1000000, data->timeout_clks);
370 BUG_ON(data->blksz * data->blocks > 524288);
371 BUG_ON(data->blksz > host->mmc->max_blk_size);
372 BUG_ON(data->blocks > 65535);
375 target_timeout = data->timeout_ns / 1000 +
376 data->timeout_clks / host->clock;
379 * Figure out needed cycles.
380 * We do this in steps in order to fit inside a 32 bit int.
381 * The first step is the minimum timeout, which will have a
382 * minimum resolution of 6 bits:
383 * (1) 2^13*1000 > 2^22,
384 * (2) host->timeout_clk < 2^16
389 current_timeout = (1 << 13) * 1000 / host->timeout_clk;
390 while (current_timeout < target_timeout) {
392 current_timeout <<= 1;
398 printk(KERN_WARNING "%s: Too large timeout requested!\n",
399 mmc_hostname(host->mmc));
403 writeb(count, host->ioaddr + SDHCI_TIMEOUT_CONTROL);
405 if (host->flags & SDHCI_USE_DMA) {
408 count = pci_map_sg(host->chip->pdev, data->sg, data->sg_len,
409 (data->flags & MMC_DATA_READ)?PCI_DMA_FROMDEVICE:PCI_DMA_TODEVICE);
412 writel(sg_dma_address(data->sg), host->ioaddr + SDHCI_DMA_ADDRESS);
414 host->size = data->blksz * data->blocks;
416 host->cur_sg = data->sg;
417 host->num_sg = data->sg_len;
420 host->remain = host->cur_sg->length;
423 /* We do not handle DMA boundaries, so set it to max (512 KiB) */
424 writew(SDHCI_MAKE_BLKSZ(7, data->blksz),
425 host->ioaddr + SDHCI_BLOCK_SIZE);
426 writew(data->blocks, host->ioaddr + SDHCI_BLOCK_COUNT);
429 static void sdhci_set_transfer_mode(struct sdhci_host *host,
430 struct mmc_data *data)
439 mode = SDHCI_TRNS_BLK_CNT_EN;
440 if (data->blocks > 1)
441 mode |= SDHCI_TRNS_MULTI;
442 if (data->flags & MMC_DATA_READ)
443 mode |= SDHCI_TRNS_READ;
444 if (host->flags & SDHCI_USE_DMA)
445 mode |= SDHCI_TRNS_DMA;
447 writew(mode, host->ioaddr + SDHCI_TRANSFER_MODE);
450 static void sdhci_finish_data(struct sdhci_host *host)
452 struct mmc_data *data;
460 if (host->flags & SDHCI_USE_DMA) {
461 pci_unmap_sg(host->chip->pdev, data->sg, data->sg_len,
462 (data->flags & MMC_DATA_READ)?PCI_DMA_FROMDEVICE:PCI_DMA_TODEVICE);
466 * Controller doesn't count down when in single block mode.
468 if ((data->blocks == 1) && (data->error == MMC_ERR_NONE))
471 blocks = readw(host->ioaddr + SDHCI_BLOCK_COUNT);
472 data->bytes_xfered = data->blksz * (data->blocks - blocks);
474 if ((data->error == MMC_ERR_NONE) && blocks) {
475 printk(KERN_ERR "%s: Controller signalled completion even "
476 "though there were blocks left. Please report this "
477 "to " BUGMAIL ".\n", mmc_hostname(host->mmc));
478 data->error = MMC_ERR_FAILED;
479 } else if (host->size != 0) {
480 printk(KERN_ERR "%s: %d bytes were left untransferred. "
481 "Please report this to " BUGMAIL ".\n",
482 mmc_hostname(host->mmc), host->size);
483 data->error = MMC_ERR_FAILED;
486 DBG("Ending data transfer (%d bytes)\n", data->bytes_xfered);
490 * The controller needs a reset of internal state machines
491 * upon error conditions.
493 if (data->error != MMC_ERR_NONE) {
494 sdhci_reset(host, SDHCI_RESET_CMD);
495 sdhci_reset(host, SDHCI_RESET_DATA);
498 sdhci_send_command(host, data->stop);
500 tasklet_schedule(&host->finish_tasklet);
503 static void sdhci_send_command(struct sdhci_host *host, struct mmc_command *cmd)
507 unsigned long timeout;
511 DBG("Sending cmd (%x)\n", cmd->opcode);
516 mask = SDHCI_CMD_INHIBIT;
517 if ((cmd->data != NULL) || (cmd->flags & MMC_RSP_BUSY))
518 mask |= SDHCI_DATA_INHIBIT;
520 /* We shouldn't wait for data inihibit for stop commands, even
521 though they might use busy signaling */
522 if (host->mrq->data && (cmd == host->mrq->data->stop))
523 mask &= ~SDHCI_DATA_INHIBIT;
525 while (readl(host->ioaddr + SDHCI_PRESENT_STATE) & mask) {
527 printk(KERN_ERR "%s: Controller never released "
528 "inhibit bit(s). Please report this to "
529 BUGMAIL ".\n", mmc_hostname(host->mmc));
530 sdhci_dumpregs(host);
531 cmd->error = MMC_ERR_FAILED;
532 tasklet_schedule(&host->finish_tasklet);
539 mod_timer(&host->timer, jiffies + 10 * HZ);
543 sdhci_prepare_data(host, cmd->data);
545 writel(cmd->arg, host->ioaddr + SDHCI_ARGUMENT);
547 sdhci_set_transfer_mode(host, cmd->data);
549 if ((cmd->flags & MMC_RSP_136) && (cmd->flags & MMC_RSP_BUSY)) {
550 printk(KERN_ERR "%s: Unsupported response type! "
551 "Please report this to " BUGMAIL ".\n",
552 mmc_hostname(host->mmc));
553 cmd->error = MMC_ERR_INVALID;
554 tasklet_schedule(&host->finish_tasklet);
558 if (!(cmd->flags & MMC_RSP_PRESENT))
559 flags = SDHCI_CMD_RESP_NONE;
560 else if (cmd->flags & MMC_RSP_136)
561 flags = SDHCI_CMD_RESP_LONG;
562 else if (cmd->flags & MMC_RSP_BUSY)
563 flags = SDHCI_CMD_RESP_SHORT_BUSY;
565 flags = SDHCI_CMD_RESP_SHORT;
567 if (cmd->flags & MMC_RSP_CRC)
568 flags |= SDHCI_CMD_CRC;
569 if (cmd->flags & MMC_RSP_OPCODE)
570 flags |= SDHCI_CMD_INDEX;
572 flags |= SDHCI_CMD_DATA;
574 writew(SDHCI_MAKE_CMD(cmd->opcode, flags),
575 host->ioaddr + SDHCI_COMMAND);
578 static void sdhci_finish_command(struct sdhci_host *host)
582 BUG_ON(host->cmd == NULL);
584 if (host->cmd->flags & MMC_RSP_PRESENT) {
585 if (host->cmd->flags & MMC_RSP_136) {
586 /* CRC is stripped so we need to do some shifting. */
587 for (i = 0;i < 4;i++) {
588 host->cmd->resp[i] = readl(host->ioaddr +
589 SDHCI_RESPONSE + (3-i)*4) << 8;
591 host->cmd->resp[i] |=
593 SDHCI_RESPONSE + (3-i)*4-1);
596 host->cmd->resp[0] = readl(host->ioaddr + SDHCI_RESPONSE);
600 host->cmd->error = MMC_ERR_NONE;
602 DBG("Ending cmd (%x)\n", host->cmd->opcode);
605 host->data = host->cmd->data;
607 tasklet_schedule(&host->finish_tasklet);
612 static void sdhci_set_clock(struct sdhci_host *host, unsigned int clock)
617 unsigned long timeout;
619 if (clock == host->clock)
622 writew(0, host->ioaddr + SDHCI_CLOCK_CONTROL);
624 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
625 if (clock > 25000000)
626 ctrl |= SDHCI_CTRL_HISPD;
628 ctrl &= ~SDHCI_CTRL_HISPD;
629 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
634 for (div = 1;div < 256;div *= 2) {
635 if ((host->max_clk / div) <= clock)
640 clk = div << SDHCI_DIVIDER_SHIFT;
641 clk |= SDHCI_CLOCK_INT_EN;
642 writew(clk, host->ioaddr + SDHCI_CLOCK_CONTROL);
646 while (!((clk = readw(host->ioaddr + SDHCI_CLOCK_CONTROL))
647 & SDHCI_CLOCK_INT_STABLE)) {
649 printk(KERN_ERR "%s: Internal clock never stabilised. "
650 "Please report this to " BUGMAIL ".\n",
651 mmc_hostname(host->mmc));
652 sdhci_dumpregs(host);
659 clk |= SDHCI_CLOCK_CARD_EN;
660 writew(clk, host->ioaddr + SDHCI_CLOCK_CONTROL);
666 static void sdhci_set_power(struct sdhci_host *host, unsigned short power)
670 if (host->power == power)
673 if (power == (unsigned short)-1) {
674 writeb(0, host->ioaddr + SDHCI_POWER_CONTROL);
679 * Spec says that we should clear the power reg before setting
680 * a new value. Some controllers don't seem to like this though.
682 if (!(host->chip->quirks & SDHCI_QUIRK_SINGLE_POWER_WRITE))
683 writeb(0, host->ioaddr + SDHCI_POWER_CONTROL);
685 pwr = SDHCI_POWER_ON;
691 pwr |= SDHCI_POWER_180;
696 pwr |= SDHCI_POWER_300;
701 pwr |= SDHCI_POWER_330;
707 writeb(pwr, host->ioaddr + SDHCI_POWER_CONTROL);
713 /*****************************************************************************\
717 \*****************************************************************************/
719 static void sdhci_request(struct mmc_host *mmc, struct mmc_request *mrq)
721 struct sdhci_host *host;
724 host = mmc_priv(mmc);
726 spin_lock_irqsave(&host->lock, flags);
728 WARN_ON(host->mrq != NULL);
730 sdhci_activate_led(host);
734 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT)) {
735 host->mrq->cmd->error = MMC_ERR_TIMEOUT;
736 tasklet_schedule(&host->finish_tasklet);
738 sdhci_send_command(host, mrq->cmd);
741 spin_unlock_irqrestore(&host->lock, flags);
744 static void sdhci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
746 struct sdhci_host *host;
750 host = mmc_priv(mmc);
752 spin_lock_irqsave(&host->lock, flags);
755 * Reset the chip on each power off.
756 * Should clear out any weird states.
758 if (ios->power_mode == MMC_POWER_OFF) {
759 writel(0, host->ioaddr + SDHCI_SIGNAL_ENABLE);
763 sdhci_set_clock(host, ios->clock);
765 if (ios->power_mode == MMC_POWER_OFF)
766 sdhci_set_power(host, -1);
768 sdhci_set_power(host, ios->vdd);
770 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
771 if (ios->bus_width == MMC_BUS_WIDTH_4)
772 ctrl |= SDHCI_CTRL_4BITBUS;
774 ctrl &= ~SDHCI_CTRL_4BITBUS;
775 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
778 spin_unlock_irqrestore(&host->lock, flags);
781 static int sdhci_get_ro(struct mmc_host *mmc)
783 struct sdhci_host *host;
787 host = mmc_priv(mmc);
789 spin_lock_irqsave(&host->lock, flags);
791 present = readl(host->ioaddr + SDHCI_PRESENT_STATE);
793 spin_unlock_irqrestore(&host->lock, flags);
795 return !(present & SDHCI_WRITE_PROTECT);
798 static const struct mmc_host_ops sdhci_ops = {
799 .request = sdhci_request,
800 .set_ios = sdhci_set_ios,
801 .get_ro = sdhci_get_ro,
804 /*****************************************************************************\
808 \*****************************************************************************/
810 static void sdhci_tasklet_card(unsigned long param)
812 struct sdhci_host *host;
815 host = (struct sdhci_host*)param;
817 spin_lock_irqsave(&host->lock, flags);
819 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT)) {
821 printk(KERN_ERR "%s: Card removed during transfer!\n",
822 mmc_hostname(host->mmc));
823 printk(KERN_ERR "%s: Resetting controller.\n",
824 mmc_hostname(host->mmc));
826 sdhci_reset(host, SDHCI_RESET_CMD);
827 sdhci_reset(host, SDHCI_RESET_DATA);
829 host->mrq->cmd->error = MMC_ERR_FAILED;
830 tasklet_schedule(&host->finish_tasklet);
834 spin_unlock_irqrestore(&host->lock, flags);
836 mmc_detect_change(host->mmc, msecs_to_jiffies(500));
839 static void sdhci_tasklet_finish(unsigned long param)
841 struct sdhci_host *host;
843 struct mmc_request *mrq;
845 host = (struct sdhci_host*)param;
847 spin_lock_irqsave(&host->lock, flags);
849 del_timer(&host->timer);
853 DBG("Ending request, cmd (%x)\n", mrq->cmd->opcode);
856 * The controller needs a reset of internal state machines
857 * upon error conditions.
859 if ((mrq->cmd->error != MMC_ERR_NONE) ||
860 (mrq->data && ((mrq->data->error != MMC_ERR_NONE) ||
861 (mrq->data->stop && (mrq->data->stop->error != MMC_ERR_NONE))))) {
863 /* Some controllers need this kick or reset won't work here */
864 if (host->chip->quirks & SDHCI_QUIRK_CLOCK_BEFORE_RESET) {
867 /* This is to force an update */
870 sdhci_set_clock(host, clock);
873 /* Spec says we should do both at the same time, but Ricoh
874 controllers do not like that. */
875 sdhci_reset(host, SDHCI_RESET_CMD);
876 sdhci_reset(host, SDHCI_RESET_DATA);
883 sdhci_deactivate_led(host);
886 spin_unlock_irqrestore(&host->lock, flags);
888 mmc_request_done(host->mmc, mrq);
891 static void sdhci_timeout_timer(unsigned long data)
893 struct sdhci_host *host;
896 host = (struct sdhci_host*)data;
898 spin_lock_irqsave(&host->lock, flags);
901 printk(KERN_ERR "%s: Timeout waiting for hardware interrupt. "
902 "Please report this to " BUGMAIL ".\n",
903 mmc_hostname(host->mmc));
904 sdhci_dumpregs(host);
907 host->data->error = MMC_ERR_TIMEOUT;
908 sdhci_finish_data(host);
911 host->cmd->error = MMC_ERR_TIMEOUT;
913 host->mrq->cmd->error = MMC_ERR_TIMEOUT;
915 tasklet_schedule(&host->finish_tasklet);
920 spin_unlock_irqrestore(&host->lock, flags);
923 /*****************************************************************************\
925 * Interrupt handling *
927 \*****************************************************************************/
929 static void sdhci_cmd_irq(struct sdhci_host *host, u32 intmask)
931 BUG_ON(intmask == 0);
934 printk(KERN_ERR "%s: Got command interrupt even though no "
935 "command operation was in progress.\n",
936 mmc_hostname(host->mmc));
937 printk(KERN_ERR "%s: Please report this to " BUGMAIL ".\n",
938 mmc_hostname(host->mmc));
939 sdhci_dumpregs(host);
943 if (intmask & SDHCI_INT_RESPONSE)
944 sdhci_finish_command(host);
946 if (intmask & SDHCI_INT_TIMEOUT)
947 host->cmd->error = MMC_ERR_TIMEOUT;
948 else if (intmask & SDHCI_INT_CRC)
949 host->cmd->error = MMC_ERR_BADCRC;
950 else if (intmask & (SDHCI_INT_END_BIT | SDHCI_INT_INDEX))
951 host->cmd->error = MMC_ERR_FAILED;
953 host->cmd->error = MMC_ERR_INVALID;
955 tasklet_schedule(&host->finish_tasklet);
959 static void sdhci_data_irq(struct sdhci_host *host, u32 intmask)
961 BUG_ON(intmask == 0);
965 * A data end interrupt is sent together with the response
966 * for the stop command.
968 if (intmask & SDHCI_INT_DATA_END)
971 printk(KERN_ERR "%s: Got data interrupt even though no "
972 "data operation was in progress.\n",
973 mmc_hostname(host->mmc));
974 printk(KERN_ERR "%s: Please report this to " BUGMAIL ".\n",
975 mmc_hostname(host->mmc));
976 sdhci_dumpregs(host);
981 if (intmask & SDHCI_INT_DATA_TIMEOUT)
982 host->data->error = MMC_ERR_TIMEOUT;
983 else if (intmask & SDHCI_INT_DATA_CRC)
984 host->data->error = MMC_ERR_BADCRC;
985 else if (intmask & SDHCI_INT_DATA_END_BIT)
986 host->data->error = MMC_ERR_FAILED;
988 if (host->data->error != MMC_ERR_NONE)
989 sdhci_finish_data(host);
991 if (intmask & (SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL))
992 sdhci_transfer_pio(host);
994 if (intmask & SDHCI_INT_DATA_END)
995 sdhci_finish_data(host);
999 static irqreturn_t sdhci_irq(int irq, void *dev_id)
1002 struct sdhci_host* host = dev_id;
1005 spin_lock(&host->lock);
1007 intmask = readl(host->ioaddr + SDHCI_INT_STATUS);
1014 DBG("*** %s got interrupt: 0x%08x\n", host->slot_descr, intmask);
1016 if (intmask & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE)) {
1017 writel(intmask & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE),
1018 host->ioaddr + SDHCI_INT_STATUS);
1019 tasklet_schedule(&host->card_tasklet);
1022 intmask &= ~(SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE);
1024 if (intmask & SDHCI_INT_CMD_MASK) {
1025 writel(intmask & SDHCI_INT_CMD_MASK,
1026 host->ioaddr + SDHCI_INT_STATUS);
1027 sdhci_cmd_irq(host, intmask & SDHCI_INT_CMD_MASK);
1030 if (intmask & SDHCI_INT_DATA_MASK) {
1031 writel(intmask & SDHCI_INT_DATA_MASK,
1032 host->ioaddr + SDHCI_INT_STATUS);
1033 sdhci_data_irq(host, intmask & SDHCI_INT_DATA_MASK);
1036 intmask &= ~(SDHCI_INT_CMD_MASK | SDHCI_INT_DATA_MASK);
1038 if (intmask & SDHCI_INT_BUS_POWER) {
1039 printk(KERN_ERR "%s: Card is consuming too much power!\n",
1040 mmc_hostname(host->mmc));
1041 writel(SDHCI_INT_BUS_POWER, host->ioaddr + SDHCI_INT_STATUS);
1044 intmask &= SDHCI_INT_BUS_POWER;
1047 printk(KERN_ERR "%s: Unexpected interrupt 0x%08x. Please "
1048 "report this to " BUGMAIL ".\n",
1049 mmc_hostname(host->mmc), intmask);
1050 sdhci_dumpregs(host);
1052 writel(intmask, host->ioaddr + SDHCI_INT_STATUS);
1055 result = IRQ_HANDLED;
1059 spin_unlock(&host->lock);
1064 /*****************************************************************************\
1068 \*****************************************************************************/
1072 static int sdhci_suspend (struct pci_dev *pdev, pm_message_t state)
1074 struct sdhci_chip *chip;
1077 chip = pci_get_drvdata(pdev);
1081 DBG("Suspending...\n");
1083 for (i = 0;i < chip->num_slots;i++) {
1084 if (!chip->hosts[i])
1086 ret = mmc_suspend_host(chip->hosts[i]->mmc, state);
1088 for (i--;i >= 0;i--)
1089 mmc_resume_host(chip->hosts[i]->mmc);
1094 pci_save_state(pdev);
1095 pci_enable_wake(pdev, pci_choose_state(pdev, state), 0);
1096 pci_disable_device(pdev);
1097 pci_set_power_state(pdev, pci_choose_state(pdev, state));
1102 static int sdhci_resume (struct pci_dev *pdev)
1104 struct sdhci_chip *chip;
1107 chip = pci_get_drvdata(pdev);
1111 DBG("Resuming...\n");
1113 pci_set_power_state(pdev, PCI_D0);
1114 pci_restore_state(pdev);
1115 ret = pci_enable_device(pdev);
1119 for (i = 0;i < chip->num_slots;i++) {
1120 if (!chip->hosts[i])
1122 if (chip->hosts[i]->flags & SDHCI_USE_DMA)
1123 pci_set_master(pdev);
1124 sdhci_init(chip->hosts[i]);
1126 ret = mmc_resume_host(chip->hosts[i]->mmc);
1134 #else /* CONFIG_PM */
1136 #define sdhci_suspend NULL
1137 #define sdhci_resume NULL
1139 #endif /* CONFIG_PM */
1141 /*****************************************************************************\
1143 * Device probing/removal *
1145 \*****************************************************************************/
1147 static int __devinit sdhci_probe_slot(struct pci_dev *pdev, int slot)
1150 unsigned int version;
1151 struct sdhci_chip *chip;
1152 struct mmc_host *mmc;
1153 struct sdhci_host *host;
1158 chip = pci_get_drvdata(pdev);
1161 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &first_bar);
1165 first_bar &= PCI_SLOT_INFO_FIRST_BAR_MASK;
1167 if (first_bar > 5) {
1168 printk(KERN_ERR DRIVER_NAME ": Invalid first BAR. Aborting.\n");
1172 if (!(pci_resource_flags(pdev, first_bar + slot) & IORESOURCE_MEM)) {
1173 printk(KERN_ERR DRIVER_NAME ": BAR is not iomem. Aborting.\n");
1177 if (pci_resource_len(pdev, first_bar + slot) != 0x100) {
1178 printk(KERN_ERR DRIVER_NAME ": Invalid iomem size. "
1179 "You may experience problems.\n");
1182 if ((pdev->class & 0x0000FF) == PCI_SDHCI_IFVENDOR) {
1183 printk(KERN_ERR DRIVER_NAME ": Vendor specific interface. Aborting.\n");
1187 if ((pdev->class & 0x0000FF) > PCI_SDHCI_IFVENDOR) {
1188 printk(KERN_ERR DRIVER_NAME ": Unknown interface. Aborting.\n");
1192 mmc = mmc_alloc_host(sizeof(struct sdhci_host), &pdev->dev);
1196 host = mmc_priv(mmc);
1200 chip->hosts[slot] = host;
1202 host->bar = first_bar + slot;
1204 host->addr = pci_resource_start(pdev, host->bar);
1205 host->irq = pdev->irq;
1207 DBG("slot %d at 0x%08lx, irq %d\n", slot, host->addr, host->irq);
1209 snprintf(host->slot_descr, 20, "sdhci:slot%d", slot);
1211 ret = pci_request_region(pdev, host->bar, host->slot_descr);
1215 host->ioaddr = ioremap_nocache(host->addr,
1216 pci_resource_len(pdev, host->bar));
1217 if (!host->ioaddr) {
1222 sdhci_reset(host, SDHCI_RESET_ALL);
1224 version = readw(host->ioaddr + SDHCI_HOST_VERSION);
1225 version = (version & SDHCI_SPEC_VER_MASK) >> SDHCI_SPEC_VER_SHIFT;
1227 printk(KERN_ERR "%s: Unknown controller version (%d). "
1228 "You may experience problems.\n", host->slot_descr,
1232 caps = readl(host->ioaddr + SDHCI_CAPABILITIES);
1235 DBG("DMA forced off\n");
1236 else if (debug_forcedma) {
1237 DBG("DMA forced on\n");
1238 host->flags |= SDHCI_USE_DMA;
1239 } else if (chip->quirks & SDHCI_QUIRK_FORCE_DMA)
1240 host->flags |= SDHCI_USE_DMA;
1241 else if ((pdev->class & 0x0000FF) != PCI_SDHCI_IFDMA)
1242 DBG("Controller doesn't have DMA interface\n");
1243 else if (!(caps & SDHCI_CAN_DO_DMA))
1244 DBG("Controller doesn't have DMA capability\n");
1246 host->flags |= SDHCI_USE_DMA;
1248 if (host->flags & SDHCI_USE_DMA) {
1249 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
1250 printk(KERN_WARNING "%s: No suitable DMA available. "
1251 "Falling back to PIO.\n", host->slot_descr);
1252 host->flags &= ~SDHCI_USE_DMA;
1256 if (host->flags & SDHCI_USE_DMA)
1257 pci_set_master(pdev);
1258 else /* XXX: Hack to get MMC layer to avoid highmem */
1262 (caps & SDHCI_CLOCK_BASE_MASK) >> SDHCI_CLOCK_BASE_SHIFT;
1263 if (host->max_clk == 0) {
1264 printk(KERN_ERR "%s: Hardware doesn't specify base clock "
1265 "frequency.\n", host->slot_descr);
1269 host->max_clk *= 1000000;
1272 (caps & SDHCI_TIMEOUT_CLK_MASK) >> SDHCI_TIMEOUT_CLK_SHIFT;
1273 if (host->timeout_clk == 0) {
1274 printk(KERN_ERR "%s: Hardware doesn't specify timeout clock "
1275 "frequency.\n", host->slot_descr);
1279 if (caps & SDHCI_TIMEOUT_CLK_UNIT)
1280 host->timeout_clk *= 1000;
1283 * Set host parameters.
1285 mmc->ops = &sdhci_ops;
1286 mmc->f_min = host->max_clk / 256;
1287 mmc->f_max = host->max_clk;
1288 mmc->caps = MMC_CAP_4_BIT_DATA | MMC_CAP_MULTIWRITE | MMC_CAP_BYTEBLOCK;
1291 if (caps & SDHCI_CAN_VDD_330)
1292 mmc->ocr_avail |= MMC_VDD_32_33|MMC_VDD_33_34;
1293 if (caps & SDHCI_CAN_VDD_300)
1294 mmc->ocr_avail |= MMC_VDD_29_30|MMC_VDD_30_31;
1295 if (caps & SDHCI_CAN_VDD_180)
1296 mmc->ocr_avail |= MMC_VDD_17_18|MMC_VDD_18_19;
1298 if ((host->max_clk > 25000000) && !(caps & SDHCI_CAN_DO_HISPD)) {
1299 printk(KERN_ERR "%s: Controller reports > 25 MHz base clock,"
1300 " but no high speed support.\n",
1302 mmc->f_max = 25000000;
1305 if (mmc->ocr_avail == 0) {
1306 printk(KERN_ERR "%s: Hardware doesn't report any "
1307 "support voltages.\n", host->slot_descr);
1312 spin_lock_init(&host->lock);
1315 * Maximum number of segments. Hardware cannot do scatter lists.
1317 if (host->flags & SDHCI_USE_DMA)
1318 mmc->max_hw_segs = 1;
1320 mmc->max_hw_segs = 16;
1321 mmc->max_phys_segs = 16;
1324 * Maximum number of sectors in one transfer. Limited by DMA boundary
1327 mmc->max_req_size = 524288;
1330 * Maximum segment size. Could be one segment with the maximum number
1333 mmc->max_seg_size = mmc->max_req_size;
1336 * Maximum block size. This varies from controller to controller and
1337 * is specified in the capabilities register.
1339 mmc->max_blk_size = (caps & SDHCI_MAX_BLOCK_MASK) >> SDHCI_MAX_BLOCK_SHIFT;
1340 if (mmc->max_blk_size >= 3) {
1341 printk(KERN_ERR "%s: Invalid maximum block size.\n",
1346 mmc->max_blk_size = 512 << mmc->max_blk_size;
1349 * Maximum block count.
1351 mmc->max_blk_count = 65535;
1356 tasklet_init(&host->card_tasklet,
1357 sdhci_tasklet_card, (unsigned long)host);
1358 tasklet_init(&host->finish_tasklet,
1359 sdhci_tasklet_finish, (unsigned long)host);
1361 setup_timer(&host->timer, sdhci_timeout_timer, (unsigned long)host);
1363 ret = request_irq(host->irq, sdhci_irq, IRQF_SHARED,
1364 host->slot_descr, host);
1370 #ifdef CONFIG_MMC_DEBUG
1371 sdhci_dumpregs(host);
1378 printk(KERN_INFO "%s: SDHCI at 0x%08lx irq %d %s\n", mmc_hostname(mmc),
1379 host->addr, host->irq,
1380 (host->flags & SDHCI_USE_DMA)?"DMA":"PIO");
1385 tasklet_kill(&host->card_tasklet);
1386 tasklet_kill(&host->finish_tasklet);
1388 iounmap(host->ioaddr);
1390 pci_release_region(pdev, host->bar);
1397 static void sdhci_remove_slot(struct pci_dev *pdev, int slot)
1399 struct sdhci_chip *chip;
1400 struct mmc_host *mmc;
1401 struct sdhci_host *host;
1403 chip = pci_get_drvdata(pdev);
1404 host = chip->hosts[slot];
1407 chip->hosts[slot] = NULL;
1409 mmc_remove_host(mmc);
1411 sdhci_reset(host, SDHCI_RESET_ALL);
1413 free_irq(host->irq, host);
1415 del_timer_sync(&host->timer);
1417 tasklet_kill(&host->card_tasklet);
1418 tasklet_kill(&host->finish_tasklet);
1420 iounmap(host->ioaddr);
1422 pci_release_region(pdev, host->bar);
1427 static int __devinit sdhci_probe(struct pci_dev *pdev,
1428 const struct pci_device_id *ent)
1432 struct sdhci_chip *chip;
1434 BUG_ON(pdev == NULL);
1435 BUG_ON(ent == NULL);
1437 pci_read_config_byte(pdev, PCI_CLASS_REVISION, &rev);
1439 printk(KERN_INFO DRIVER_NAME
1440 ": SDHCI controller found at %s [%04x:%04x] (rev %x)\n",
1441 pci_name(pdev), (int)pdev->vendor, (int)pdev->device,
1444 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &slots);
1448 slots = PCI_SLOT_INFO_SLOTS(slots) + 1;
1449 DBG("found %d slot(s)\n", slots);
1453 ret = pci_enable_device(pdev);
1457 chip = kzalloc(sizeof(struct sdhci_chip) +
1458 sizeof(struct sdhci_host*) * slots, GFP_KERNEL);
1465 chip->quirks = ent->driver_data;
1468 chip->quirks = debug_quirks;
1470 chip->num_slots = slots;
1471 pci_set_drvdata(pdev, chip);
1473 for (i = 0;i < slots;i++) {
1474 ret = sdhci_probe_slot(pdev, i);
1476 for (i--;i >= 0;i--)
1477 sdhci_remove_slot(pdev, i);
1485 pci_set_drvdata(pdev, NULL);
1489 pci_disable_device(pdev);
1493 static void __devexit sdhci_remove(struct pci_dev *pdev)
1496 struct sdhci_chip *chip;
1498 chip = pci_get_drvdata(pdev);
1501 for (i = 0;i < chip->num_slots;i++)
1502 sdhci_remove_slot(pdev, i);
1504 pci_set_drvdata(pdev, NULL);
1509 pci_disable_device(pdev);
1512 static struct pci_driver sdhci_driver = {
1513 .name = DRIVER_NAME,
1514 .id_table = pci_ids,
1515 .probe = sdhci_probe,
1516 .remove = __devexit_p(sdhci_remove),
1517 .suspend = sdhci_suspend,
1518 .resume = sdhci_resume,
1521 /*****************************************************************************\
1523 * Driver init/exit *
1525 \*****************************************************************************/
1527 static int __init sdhci_drv_init(void)
1529 printk(KERN_INFO DRIVER_NAME
1530 ": Secure Digital Host Controller Interface driver\n");
1531 printk(KERN_INFO DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1533 return pci_register_driver(&sdhci_driver);
1536 static void __exit sdhci_drv_exit(void)
1540 pci_unregister_driver(&sdhci_driver);
1543 module_init(sdhci_drv_init);
1544 module_exit(sdhci_drv_exit);
1546 module_param(debug_nodma, uint, 0444);
1547 module_param(debug_forcedma, uint, 0444);
1548 module_param(debug_quirks, uint, 0444);
1550 MODULE_AUTHOR("Pierre Ossman <drzeus@drzeus.cx>");
1551 MODULE_DESCRIPTION("Secure Digital Host Controller Interface driver");
1552 MODULE_LICENSE("GPL");
1554 MODULE_PARM_DESC(debug_nodma, "Forcefully disable DMA transfers. (default 0)");
1555 MODULE_PARM_DESC(debug_forcedma, "Forcefully enable DMA transfers. (default 0)");
1556 MODULE_PARM_DESC(debug_quirks, "Force certain quirks.");