2 * linux/drivers/mmc/sdhci.c - Secure Digital Host Controller Interface driver
4 * Copyright (C) 2005-2007 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 DBG(f, x...) \
27 pr_debug(DRIVER_NAME " [%s()]: " f, __func__,## x)
29 static unsigned int debug_nodma = 0;
30 static unsigned int debug_forcedma = 0;
31 static unsigned int debug_quirks = 0;
33 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
34 #define SDHCI_QUIRK_FORCE_DMA (1<<1)
35 /* Controller doesn't like some resets when there is no card inserted. */
36 #define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
37 #define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
39 static const struct pci_device_id pci_ids[] __devinitdata = {
41 .vendor = PCI_VENDOR_ID_RICOH,
42 .device = PCI_DEVICE_ID_RICOH_R5C822,
43 .subvendor = PCI_VENDOR_ID_IBM,
44 .subdevice = PCI_ANY_ID,
45 .driver_data = SDHCI_QUIRK_CLOCK_BEFORE_RESET |
46 SDHCI_QUIRK_FORCE_DMA,
50 .vendor = PCI_VENDOR_ID_RICOH,
51 .device = PCI_DEVICE_ID_RICOH_R5C822,
52 .subvendor = PCI_ANY_ID,
53 .subdevice = PCI_ANY_ID,
54 .driver_data = SDHCI_QUIRK_FORCE_DMA |
55 SDHCI_QUIRK_NO_CARD_NO_RESET,
59 .vendor = PCI_VENDOR_ID_TI,
60 .device = PCI_DEVICE_ID_TI_XX21_XX11_SD,
61 .subvendor = PCI_ANY_ID,
62 .subdevice = PCI_ANY_ID,
63 .driver_data = SDHCI_QUIRK_FORCE_DMA,
67 .vendor = PCI_VENDOR_ID_ENE,
68 .device = PCI_DEVICE_ID_ENE_CB712_SD,
69 .subvendor = PCI_ANY_ID,
70 .subdevice = PCI_ANY_ID,
71 .driver_data = SDHCI_QUIRK_SINGLE_POWER_WRITE,
74 { /* Generic SD host controller */
75 PCI_DEVICE_CLASS((PCI_CLASS_SYSTEM_SDHCI << 8), 0xFFFF00)
78 { /* end: all zeroes */ },
81 MODULE_DEVICE_TABLE(pci, pci_ids);
83 static void sdhci_prepare_data(struct sdhci_host *, struct mmc_data *);
84 static void sdhci_finish_data(struct sdhci_host *);
86 static void sdhci_send_command(struct sdhci_host *, struct mmc_command *);
87 static void sdhci_finish_command(struct sdhci_host *);
89 static void sdhci_dumpregs(struct sdhci_host *host)
91 printk(KERN_DEBUG DRIVER_NAME ": ============== REGISTER DUMP ==============\n");
93 printk(KERN_DEBUG DRIVER_NAME ": Sys addr: 0x%08x | Version: 0x%08x\n",
94 readl(host->ioaddr + SDHCI_DMA_ADDRESS),
95 readw(host->ioaddr + SDHCI_HOST_VERSION));
96 printk(KERN_DEBUG DRIVER_NAME ": Blk size: 0x%08x | Blk cnt: 0x%08x\n",
97 readw(host->ioaddr + SDHCI_BLOCK_SIZE),
98 readw(host->ioaddr + SDHCI_BLOCK_COUNT));
99 printk(KERN_DEBUG DRIVER_NAME ": Argument: 0x%08x | Trn mode: 0x%08x\n",
100 readl(host->ioaddr + SDHCI_ARGUMENT),
101 readw(host->ioaddr + SDHCI_TRANSFER_MODE));
102 printk(KERN_DEBUG DRIVER_NAME ": Present: 0x%08x | Host ctl: 0x%08x\n",
103 readl(host->ioaddr + SDHCI_PRESENT_STATE),
104 readb(host->ioaddr + SDHCI_HOST_CONTROL));
105 printk(KERN_DEBUG DRIVER_NAME ": Power: 0x%08x | Blk gap: 0x%08x\n",
106 readb(host->ioaddr + SDHCI_POWER_CONTROL),
107 readb(host->ioaddr + SDHCI_BLOCK_GAP_CONTROL));
108 printk(KERN_DEBUG DRIVER_NAME ": Wake-up: 0x%08x | Clock: 0x%08x\n",
109 readb(host->ioaddr + SDHCI_WALK_UP_CONTROL),
110 readw(host->ioaddr + SDHCI_CLOCK_CONTROL));
111 printk(KERN_DEBUG DRIVER_NAME ": Timeout: 0x%08x | Int stat: 0x%08x\n",
112 readb(host->ioaddr + SDHCI_TIMEOUT_CONTROL),
113 readl(host->ioaddr + SDHCI_INT_STATUS));
114 printk(KERN_DEBUG DRIVER_NAME ": Int enab: 0x%08x | Sig enab: 0x%08x\n",
115 readl(host->ioaddr + SDHCI_INT_ENABLE),
116 readl(host->ioaddr + SDHCI_SIGNAL_ENABLE));
117 printk(KERN_DEBUG DRIVER_NAME ": AC12 err: 0x%08x | Slot int: 0x%08x\n",
118 readw(host->ioaddr + SDHCI_ACMD12_ERR),
119 readw(host->ioaddr + SDHCI_SLOT_INT_STATUS));
120 printk(KERN_DEBUG DRIVER_NAME ": Caps: 0x%08x | Max curr: 0x%08x\n",
121 readl(host->ioaddr + SDHCI_CAPABILITIES),
122 readl(host->ioaddr + SDHCI_MAX_CURRENT));
124 printk(KERN_DEBUG DRIVER_NAME ": ===========================================\n");
127 /*****************************************************************************\
129 * Low level functions *
131 \*****************************************************************************/
133 static void sdhci_reset(struct sdhci_host *host, u8 mask)
135 unsigned long timeout;
137 if (host->chip->quirks & SDHCI_QUIRK_NO_CARD_NO_RESET) {
138 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) &
143 writeb(mask, host->ioaddr + SDHCI_SOFTWARE_RESET);
145 if (mask & SDHCI_RESET_ALL)
148 /* Wait max 100 ms */
151 /* hw clears the bit when it's done */
152 while (readb(host->ioaddr + SDHCI_SOFTWARE_RESET) & mask) {
154 printk(KERN_ERR "%s: Reset 0x%x never completed.\n",
155 mmc_hostname(host->mmc), (int)mask);
156 sdhci_dumpregs(host);
164 static void sdhci_init(struct sdhci_host *host)
168 sdhci_reset(host, SDHCI_RESET_ALL);
170 intmask = SDHCI_INT_BUS_POWER | SDHCI_INT_DATA_END_BIT |
171 SDHCI_INT_DATA_CRC | SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_INDEX |
172 SDHCI_INT_END_BIT | SDHCI_INT_CRC | SDHCI_INT_TIMEOUT |
173 SDHCI_INT_CARD_REMOVE | SDHCI_INT_CARD_INSERT |
174 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL |
175 SDHCI_INT_DMA_END | SDHCI_INT_DATA_END | SDHCI_INT_RESPONSE;
177 writel(intmask, host->ioaddr + SDHCI_INT_ENABLE);
178 writel(intmask, host->ioaddr + SDHCI_SIGNAL_ENABLE);
181 static void sdhci_activate_led(struct sdhci_host *host)
185 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
186 ctrl |= SDHCI_CTRL_LED;
187 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
190 static void sdhci_deactivate_led(struct sdhci_host *host)
194 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
195 ctrl &= ~SDHCI_CTRL_LED;
196 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
199 /*****************************************************************************\
203 \*****************************************************************************/
205 static inline char* sdhci_sg_to_buffer(struct sdhci_host* host)
207 return page_address(host->cur_sg->page) + host->cur_sg->offset;
210 static inline int sdhci_next_sg(struct sdhci_host* host)
213 * Skip to next SG entry.
221 if (host->num_sg > 0) {
223 host->remain = host->cur_sg->length;
229 static void sdhci_read_block_pio(struct sdhci_host *host)
231 int blksize, chunk_remain;
236 DBG("PIO reading\n");
238 blksize = host->data->blksz;
242 buffer = sdhci_sg_to_buffer(host) + host->offset;
245 if (chunk_remain == 0) {
246 data = readl(host->ioaddr + SDHCI_BUFFER);
247 chunk_remain = min(blksize, 4);
250 size = min(host->remain, chunk_remain);
252 chunk_remain -= size;
254 host->offset += size;
255 host->remain -= size;
258 *buffer = data & 0xFF;
264 if (host->remain == 0) {
265 if (sdhci_next_sg(host) == 0) {
266 BUG_ON(blksize != 0);
269 buffer = sdhci_sg_to_buffer(host);
274 static void sdhci_write_block_pio(struct sdhci_host *host)
276 int blksize, chunk_remain;
281 DBG("PIO writing\n");
283 blksize = host->data->blksz;
288 buffer = sdhci_sg_to_buffer(host) + host->offset;
291 size = min(host->remain, chunk_remain);
293 chunk_remain -= size;
295 host->offset += size;
296 host->remain -= size;
300 data |= (u32)*buffer << 24;
305 if (chunk_remain == 0) {
306 writel(data, host->ioaddr + SDHCI_BUFFER);
307 chunk_remain = min(blksize, 4);
310 if (host->remain == 0) {
311 if (sdhci_next_sg(host) == 0) {
312 BUG_ON(blksize != 0);
315 buffer = sdhci_sg_to_buffer(host);
320 static void sdhci_transfer_pio(struct sdhci_host *host)
326 if (host->num_sg == 0)
329 if (host->data->flags & MMC_DATA_READ)
330 mask = SDHCI_DATA_AVAILABLE;
332 mask = SDHCI_SPACE_AVAILABLE;
334 while (readl(host->ioaddr + SDHCI_PRESENT_STATE) & mask) {
335 if (host->data->flags & MMC_DATA_READ)
336 sdhci_read_block_pio(host);
338 sdhci_write_block_pio(host);
340 if (host->num_sg == 0)
344 DBG("PIO transfer complete.\n");
347 static void sdhci_prepare_data(struct sdhci_host *host, struct mmc_data *data)
350 unsigned target_timeout, current_timeout;
357 DBG("blksz %04x blks %04x flags %08x\n",
358 data->blksz, data->blocks, data->flags);
359 DBG("tsac %d ms nsac %d clk\n",
360 data->timeout_ns / 1000000, data->timeout_clks);
363 BUG_ON(data->blksz * data->blocks > 524288);
364 BUG_ON(data->blksz > host->mmc->max_blk_size);
365 BUG_ON(data->blocks > 65535);
368 target_timeout = data->timeout_ns / 1000 +
369 data->timeout_clks / host->clock;
372 * Figure out needed cycles.
373 * We do this in steps in order to fit inside a 32 bit int.
374 * The first step is the minimum timeout, which will have a
375 * minimum resolution of 6 bits:
376 * (1) 2^13*1000 > 2^22,
377 * (2) host->timeout_clk < 2^16
382 current_timeout = (1 << 13) * 1000 / host->timeout_clk;
383 while (current_timeout < target_timeout) {
385 current_timeout <<= 1;
391 printk(KERN_WARNING "%s: Too large timeout requested!\n",
392 mmc_hostname(host->mmc));
396 writeb(count, host->ioaddr + SDHCI_TIMEOUT_CONTROL);
398 if (host->flags & SDHCI_USE_DMA) {
401 count = pci_map_sg(host->chip->pdev, data->sg, data->sg_len,
402 (data->flags & MMC_DATA_READ)?PCI_DMA_FROMDEVICE:PCI_DMA_TODEVICE);
405 writel(sg_dma_address(data->sg), host->ioaddr + SDHCI_DMA_ADDRESS);
407 host->cur_sg = data->sg;
408 host->num_sg = data->sg_len;
411 host->remain = host->cur_sg->length;
414 /* We do not handle DMA boundaries, so set it to max (512 KiB) */
415 writew(SDHCI_MAKE_BLKSZ(7, data->blksz),
416 host->ioaddr + SDHCI_BLOCK_SIZE);
417 writew(data->blocks, host->ioaddr + SDHCI_BLOCK_COUNT);
420 static void sdhci_set_transfer_mode(struct sdhci_host *host,
421 struct mmc_data *data)
430 mode = SDHCI_TRNS_BLK_CNT_EN;
431 if (data->blocks > 1)
432 mode |= SDHCI_TRNS_MULTI;
433 if (data->flags & MMC_DATA_READ)
434 mode |= SDHCI_TRNS_READ;
435 if (host->flags & SDHCI_USE_DMA)
436 mode |= SDHCI_TRNS_DMA;
438 writew(mode, host->ioaddr + SDHCI_TRANSFER_MODE);
441 static void sdhci_finish_data(struct sdhci_host *host)
443 struct mmc_data *data;
451 if (host->flags & SDHCI_USE_DMA) {
452 pci_unmap_sg(host->chip->pdev, data->sg, data->sg_len,
453 (data->flags & MMC_DATA_READ)?PCI_DMA_FROMDEVICE:PCI_DMA_TODEVICE);
457 * Controller doesn't count down when in single block mode.
459 if ((data->blocks == 1) && (data->error == MMC_ERR_NONE))
462 blocks = readw(host->ioaddr + SDHCI_BLOCK_COUNT);
463 data->bytes_xfered = data->blksz * (data->blocks - blocks);
465 if ((data->error == MMC_ERR_NONE) && blocks) {
466 printk(KERN_ERR "%s: Controller signalled completion even "
467 "though there were blocks left.\n",
468 mmc_hostname(host->mmc));
469 data->error = MMC_ERR_FAILED;
472 DBG("Ending data transfer (%d bytes)\n", data->bytes_xfered);
476 * The controller needs a reset of internal state machines
477 * upon error conditions.
479 if (data->error != MMC_ERR_NONE) {
480 sdhci_reset(host, SDHCI_RESET_CMD);
481 sdhci_reset(host, SDHCI_RESET_DATA);
484 sdhci_send_command(host, data->stop);
486 tasklet_schedule(&host->finish_tasklet);
489 static void sdhci_send_command(struct sdhci_host *host, struct mmc_command *cmd)
493 unsigned long timeout;
497 DBG("Sending cmd (%x)\n", cmd->opcode);
502 mask = SDHCI_CMD_INHIBIT;
503 if ((cmd->data != NULL) || (cmd->flags & MMC_RSP_BUSY))
504 mask |= SDHCI_DATA_INHIBIT;
506 /* We shouldn't wait for data inihibit for stop commands, even
507 though they might use busy signaling */
508 if (host->mrq->data && (cmd == host->mrq->data->stop))
509 mask &= ~SDHCI_DATA_INHIBIT;
511 while (readl(host->ioaddr + SDHCI_PRESENT_STATE) & mask) {
513 printk(KERN_ERR "%s: Controller never released "
514 "inhibit bit(s).\n", mmc_hostname(host->mmc));
515 sdhci_dumpregs(host);
516 cmd->error = MMC_ERR_FAILED;
517 tasklet_schedule(&host->finish_tasklet);
524 mod_timer(&host->timer, jiffies + 10 * HZ);
528 sdhci_prepare_data(host, cmd->data);
530 writel(cmd->arg, host->ioaddr + SDHCI_ARGUMENT);
532 sdhci_set_transfer_mode(host, cmd->data);
534 if ((cmd->flags & MMC_RSP_136) && (cmd->flags & MMC_RSP_BUSY)) {
535 printk(KERN_ERR "%s: Unsupported response type!\n",
536 mmc_hostname(host->mmc));
537 cmd->error = MMC_ERR_INVALID;
538 tasklet_schedule(&host->finish_tasklet);
542 if (!(cmd->flags & MMC_RSP_PRESENT))
543 flags = SDHCI_CMD_RESP_NONE;
544 else if (cmd->flags & MMC_RSP_136)
545 flags = SDHCI_CMD_RESP_LONG;
546 else if (cmd->flags & MMC_RSP_BUSY)
547 flags = SDHCI_CMD_RESP_SHORT_BUSY;
549 flags = SDHCI_CMD_RESP_SHORT;
551 if (cmd->flags & MMC_RSP_CRC)
552 flags |= SDHCI_CMD_CRC;
553 if (cmd->flags & MMC_RSP_OPCODE)
554 flags |= SDHCI_CMD_INDEX;
556 flags |= SDHCI_CMD_DATA;
558 writew(SDHCI_MAKE_CMD(cmd->opcode, flags),
559 host->ioaddr + SDHCI_COMMAND);
562 static void sdhci_finish_command(struct sdhci_host *host)
566 BUG_ON(host->cmd == NULL);
568 if (host->cmd->flags & MMC_RSP_PRESENT) {
569 if (host->cmd->flags & MMC_RSP_136) {
570 /* CRC is stripped so we need to do some shifting. */
571 for (i = 0;i < 4;i++) {
572 host->cmd->resp[i] = readl(host->ioaddr +
573 SDHCI_RESPONSE + (3-i)*4) << 8;
575 host->cmd->resp[i] |=
577 SDHCI_RESPONSE + (3-i)*4-1);
580 host->cmd->resp[0] = readl(host->ioaddr + SDHCI_RESPONSE);
584 host->cmd->error = MMC_ERR_NONE;
586 DBG("Ending cmd (%x)\n", host->cmd->opcode);
589 host->data = host->cmd->data;
591 tasklet_schedule(&host->finish_tasklet);
596 static void sdhci_set_clock(struct sdhci_host *host, unsigned int clock)
600 unsigned long timeout;
602 if (clock == host->clock)
605 writew(0, host->ioaddr + SDHCI_CLOCK_CONTROL);
610 for (div = 1;div < 256;div *= 2) {
611 if ((host->max_clk / div) <= clock)
616 clk = div << SDHCI_DIVIDER_SHIFT;
617 clk |= SDHCI_CLOCK_INT_EN;
618 writew(clk, host->ioaddr + SDHCI_CLOCK_CONTROL);
622 while (!((clk = readw(host->ioaddr + SDHCI_CLOCK_CONTROL))
623 & SDHCI_CLOCK_INT_STABLE)) {
625 printk(KERN_ERR "%s: Internal clock never "
626 "stabilised.\n", mmc_hostname(host->mmc));
627 sdhci_dumpregs(host);
634 clk |= SDHCI_CLOCK_CARD_EN;
635 writew(clk, host->ioaddr + SDHCI_CLOCK_CONTROL);
641 static void sdhci_set_power(struct sdhci_host *host, unsigned short power)
645 if (host->power == power)
648 if (power == (unsigned short)-1) {
649 writeb(0, host->ioaddr + SDHCI_POWER_CONTROL);
654 * Spec says that we should clear the power reg before setting
655 * a new value. Some controllers don't seem to like this though.
657 if (!(host->chip->quirks & SDHCI_QUIRK_SINGLE_POWER_WRITE))
658 writeb(0, host->ioaddr + SDHCI_POWER_CONTROL);
660 pwr = SDHCI_POWER_ON;
666 pwr |= SDHCI_POWER_180;
671 pwr |= SDHCI_POWER_300;
676 pwr |= SDHCI_POWER_330;
682 writeb(pwr, host->ioaddr + SDHCI_POWER_CONTROL);
688 /*****************************************************************************\
692 \*****************************************************************************/
694 static void sdhci_request(struct mmc_host *mmc, struct mmc_request *mrq)
696 struct sdhci_host *host;
699 host = mmc_priv(mmc);
701 spin_lock_irqsave(&host->lock, flags);
703 WARN_ON(host->mrq != NULL);
705 sdhci_activate_led(host);
709 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT)) {
710 host->mrq->cmd->error = MMC_ERR_TIMEOUT;
711 tasklet_schedule(&host->finish_tasklet);
713 sdhci_send_command(host, mrq->cmd);
716 spin_unlock_irqrestore(&host->lock, flags);
719 static void sdhci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
721 struct sdhci_host *host;
725 host = mmc_priv(mmc);
727 spin_lock_irqsave(&host->lock, flags);
730 * Reset the chip on each power off.
731 * Should clear out any weird states.
733 if (ios->power_mode == MMC_POWER_OFF) {
734 writel(0, host->ioaddr + SDHCI_SIGNAL_ENABLE);
738 sdhci_set_clock(host, ios->clock);
740 if (ios->power_mode == MMC_POWER_OFF)
741 sdhci_set_power(host, -1);
743 sdhci_set_power(host, ios->vdd);
745 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
747 if (ios->bus_width == MMC_BUS_WIDTH_4)
748 ctrl |= SDHCI_CTRL_4BITBUS;
750 ctrl &= ~SDHCI_CTRL_4BITBUS;
752 if (ios->timing == MMC_TIMING_SD_HS)
753 ctrl |= SDHCI_CTRL_HISPD;
755 ctrl &= ~SDHCI_CTRL_HISPD;
757 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
760 spin_unlock_irqrestore(&host->lock, flags);
763 static int sdhci_get_ro(struct mmc_host *mmc)
765 struct sdhci_host *host;
769 host = mmc_priv(mmc);
771 spin_lock_irqsave(&host->lock, flags);
773 present = readl(host->ioaddr + SDHCI_PRESENT_STATE);
775 spin_unlock_irqrestore(&host->lock, flags);
777 return !(present & SDHCI_WRITE_PROTECT);
780 static const struct mmc_host_ops sdhci_ops = {
781 .request = sdhci_request,
782 .set_ios = sdhci_set_ios,
783 .get_ro = sdhci_get_ro,
786 /*****************************************************************************\
790 \*****************************************************************************/
792 static void sdhci_tasklet_card(unsigned long param)
794 struct sdhci_host *host;
797 host = (struct sdhci_host*)param;
799 spin_lock_irqsave(&host->lock, flags);
801 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT)) {
803 printk(KERN_ERR "%s: Card removed during transfer!\n",
804 mmc_hostname(host->mmc));
805 printk(KERN_ERR "%s: Resetting controller.\n",
806 mmc_hostname(host->mmc));
808 sdhci_reset(host, SDHCI_RESET_CMD);
809 sdhci_reset(host, SDHCI_RESET_DATA);
811 host->mrq->cmd->error = MMC_ERR_FAILED;
812 tasklet_schedule(&host->finish_tasklet);
816 spin_unlock_irqrestore(&host->lock, flags);
818 mmc_detect_change(host->mmc, msecs_to_jiffies(500));
821 static void sdhci_tasklet_finish(unsigned long param)
823 struct sdhci_host *host;
825 struct mmc_request *mrq;
827 host = (struct sdhci_host*)param;
829 spin_lock_irqsave(&host->lock, flags);
831 del_timer(&host->timer);
835 DBG("Ending request, cmd (%x)\n", mrq->cmd->opcode);
838 * The controller needs a reset of internal state machines
839 * upon error conditions.
841 if ((mrq->cmd->error != MMC_ERR_NONE) ||
842 (mrq->data && ((mrq->data->error != MMC_ERR_NONE) ||
843 (mrq->data->stop && (mrq->data->stop->error != MMC_ERR_NONE))))) {
845 /* Some controllers need this kick or reset won't work here */
846 if (host->chip->quirks & SDHCI_QUIRK_CLOCK_BEFORE_RESET) {
849 /* This is to force an update */
852 sdhci_set_clock(host, clock);
855 /* Spec says we should do both at the same time, but Ricoh
856 controllers do not like that. */
857 sdhci_reset(host, SDHCI_RESET_CMD);
858 sdhci_reset(host, SDHCI_RESET_DATA);
865 sdhci_deactivate_led(host);
868 spin_unlock_irqrestore(&host->lock, flags);
870 mmc_request_done(host->mmc, mrq);
873 static void sdhci_timeout_timer(unsigned long data)
875 struct sdhci_host *host;
878 host = (struct sdhci_host*)data;
880 spin_lock_irqsave(&host->lock, flags);
883 printk(KERN_ERR "%s: Timeout waiting for hardware "
884 "interrupt.\n", mmc_hostname(host->mmc));
885 sdhci_dumpregs(host);
888 host->data->error = MMC_ERR_TIMEOUT;
889 sdhci_finish_data(host);
892 host->cmd->error = MMC_ERR_TIMEOUT;
894 host->mrq->cmd->error = MMC_ERR_TIMEOUT;
896 tasklet_schedule(&host->finish_tasklet);
901 spin_unlock_irqrestore(&host->lock, flags);
904 /*****************************************************************************\
906 * Interrupt handling *
908 \*****************************************************************************/
910 static void sdhci_cmd_irq(struct sdhci_host *host, u32 intmask)
912 BUG_ON(intmask == 0);
915 printk(KERN_ERR "%s: Got command interrupt even though no "
916 "command operation was in progress.\n",
917 mmc_hostname(host->mmc));
918 sdhci_dumpregs(host);
922 if (intmask & SDHCI_INT_RESPONSE)
923 sdhci_finish_command(host);
925 if (intmask & SDHCI_INT_TIMEOUT)
926 host->cmd->error = MMC_ERR_TIMEOUT;
927 else if (intmask & SDHCI_INT_CRC)
928 host->cmd->error = MMC_ERR_BADCRC;
929 else if (intmask & (SDHCI_INT_END_BIT | SDHCI_INT_INDEX))
930 host->cmd->error = MMC_ERR_FAILED;
932 host->cmd->error = MMC_ERR_INVALID;
934 tasklet_schedule(&host->finish_tasklet);
938 static void sdhci_data_irq(struct sdhci_host *host, u32 intmask)
940 BUG_ON(intmask == 0);
944 * A data end interrupt is sent together with the response
945 * for the stop command.
947 if (intmask & SDHCI_INT_DATA_END)
950 printk(KERN_ERR "%s: Got data interrupt even though no "
951 "data operation was in progress.\n",
952 mmc_hostname(host->mmc));
953 sdhci_dumpregs(host);
958 if (intmask & SDHCI_INT_DATA_TIMEOUT)
959 host->data->error = MMC_ERR_TIMEOUT;
960 else if (intmask & SDHCI_INT_DATA_CRC)
961 host->data->error = MMC_ERR_BADCRC;
962 else if (intmask & SDHCI_INT_DATA_END_BIT)
963 host->data->error = MMC_ERR_FAILED;
965 if (host->data->error != MMC_ERR_NONE)
966 sdhci_finish_data(host);
968 if (intmask & (SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL))
969 sdhci_transfer_pio(host);
971 if (intmask & SDHCI_INT_DATA_END)
972 sdhci_finish_data(host);
976 static irqreturn_t sdhci_irq(int irq, void *dev_id)
979 struct sdhci_host* host = dev_id;
982 spin_lock(&host->lock);
984 intmask = readl(host->ioaddr + SDHCI_INT_STATUS);
986 if (!intmask || intmask == 0xffffffff) {
991 DBG("*** %s got interrupt: 0x%08x\n", host->slot_descr, intmask);
993 if (intmask & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE)) {
994 writel(intmask & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE),
995 host->ioaddr + SDHCI_INT_STATUS);
996 tasklet_schedule(&host->card_tasklet);
999 intmask &= ~(SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE);
1001 if (intmask & SDHCI_INT_CMD_MASK) {
1002 writel(intmask & SDHCI_INT_CMD_MASK,
1003 host->ioaddr + SDHCI_INT_STATUS);
1004 sdhci_cmd_irq(host, intmask & SDHCI_INT_CMD_MASK);
1007 if (intmask & SDHCI_INT_DATA_MASK) {
1008 writel(intmask & SDHCI_INT_DATA_MASK,
1009 host->ioaddr + SDHCI_INT_STATUS);
1010 sdhci_data_irq(host, intmask & SDHCI_INT_DATA_MASK);
1013 intmask &= ~(SDHCI_INT_CMD_MASK | SDHCI_INT_DATA_MASK);
1015 if (intmask & SDHCI_INT_BUS_POWER) {
1016 printk(KERN_ERR "%s: Card is consuming too much power!\n",
1017 mmc_hostname(host->mmc));
1018 writel(SDHCI_INT_BUS_POWER, host->ioaddr + SDHCI_INT_STATUS);
1021 intmask &= SDHCI_INT_BUS_POWER;
1024 printk(KERN_ERR "%s: Unexpected interrupt 0x%08x.\n",
1025 mmc_hostname(host->mmc), intmask);
1026 sdhci_dumpregs(host);
1028 writel(intmask, host->ioaddr + SDHCI_INT_STATUS);
1031 result = IRQ_HANDLED;
1035 spin_unlock(&host->lock);
1040 /*****************************************************************************\
1044 \*****************************************************************************/
1048 static int sdhci_suspend (struct pci_dev *pdev, pm_message_t state)
1050 struct sdhci_chip *chip;
1053 chip = pci_get_drvdata(pdev);
1057 DBG("Suspending...\n");
1059 for (i = 0;i < chip->num_slots;i++) {
1060 if (!chip->hosts[i])
1062 ret = mmc_suspend_host(chip->hosts[i]->mmc, state);
1064 for (i--;i >= 0;i--)
1065 mmc_resume_host(chip->hosts[i]->mmc);
1070 pci_save_state(pdev);
1071 pci_enable_wake(pdev, pci_choose_state(pdev, state), 0);
1073 for (i = 0;i < chip->num_slots;i++) {
1074 if (!chip->hosts[i])
1076 free_irq(chip->hosts[i]->irq, chip->hosts[i]);
1079 pci_disable_device(pdev);
1080 pci_set_power_state(pdev, pci_choose_state(pdev, state));
1085 static int sdhci_resume (struct pci_dev *pdev)
1087 struct sdhci_chip *chip;
1090 chip = pci_get_drvdata(pdev);
1094 DBG("Resuming...\n");
1096 pci_set_power_state(pdev, PCI_D0);
1097 pci_restore_state(pdev);
1098 ret = pci_enable_device(pdev);
1102 for (i = 0;i < chip->num_slots;i++) {
1103 if (!chip->hosts[i])
1105 if (chip->hosts[i]->flags & SDHCI_USE_DMA)
1106 pci_set_master(pdev);
1107 ret = request_irq(chip->hosts[i]->irq, sdhci_irq,
1108 IRQF_SHARED, chip->hosts[i]->slot_descr,
1112 sdhci_init(chip->hosts[i]);
1114 ret = mmc_resume_host(chip->hosts[i]->mmc);
1122 #else /* CONFIG_PM */
1124 #define sdhci_suspend NULL
1125 #define sdhci_resume NULL
1127 #endif /* CONFIG_PM */
1129 /*****************************************************************************\
1131 * Device probing/removal *
1133 \*****************************************************************************/
1135 static int __devinit sdhci_probe_slot(struct pci_dev *pdev, int slot)
1138 unsigned int version;
1139 struct sdhci_chip *chip;
1140 struct mmc_host *mmc;
1141 struct sdhci_host *host;
1146 chip = pci_get_drvdata(pdev);
1149 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &first_bar);
1153 first_bar &= PCI_SLOT_INFO_FIRST_BAR_MASK;
1155 if (first_bar > 5) {
1156 printk(KERN_ERR DRIVER_NAME ": Invalid first BAR. Aborting.\n");
1160 if (!(pci_resource_flags(pdev, first_bar + slot) & IORESOURCE_MEM)) {
1161 printk(KERN_ERR DRIVER_NAME ": BAR is not iomem. Aborting.\n");
1165 if (pci_resource_len(pdev, first_bar + slot) != 0x100) {
1166 printk(KERN_ERR DRIVER_NAME ": Invalid iomem size. "
1167 "You may experience problems.\n");
1170 if ((pdev->class & 0x0000FF) == PCI_SDHCI_IFVENDOR) {
1171 printk(KERN_ERR DRIVER_NAME ": Vendor specific interface. Aborting.\n");
1175 if ((pdev->class & 0x0000FF) > PCI_SDHCI_IFVENDOR) {
1176 printk(KERN_ERR DRIVER_NAME ": Unknown interface. Aborting.\n");
1180 mmc = mmc_alloc_host(sizeof(struct sdhci_host), &pdev->dev);
1184 host = mmc_priv(mmc);
1188 chip->hosts[slot] = host;
1190 host->bar = first_bar + slot;
1192 host->addr = pci_resource_start(pdev, host->bar);
1193 host->irq = pdev->irq;
1195 DBG("slot %d at 0x%08lx, irq %d\n", slot, host->addr, host->irq);
1197 snprintf(host->slot_descr, 20, "sdhci:slot%d", slot);
1199 ret = pci_request_region(pdev, host->bar, host->slot_descr);
1203 host->ioaddr = ioremap_nocache(host->addr,
1204 pci_resource_len(pdev, host->bar));
1205 if (!host->ioaddr) {
1210 sdhci_reset(host, SDHCI_RESET_ALL);
1212 version = readw(host->ioaddr + SDHCI_HOST_VERSION);
1213 version = (version & SDHCI_SPEC_VER_MASK) >> SDHCI_SPEC_VER_SHIFT;
1215 printk(KERN_ERR "%s: Unknown controller version (%d). "
1216 "You may experience problems.\n", host->slot_descr,
1220 caps = readl(host->ioaddr + SDHCI_CAPABILITIES);
1223 DBG("DMA forced off\n");
1224 else if (debug_forcedma) {
1225 DBG("DMA forced on\n");
1226 host->flags |= SDHCI_USE_DMA;
1227 } else if (chip->quirks & SDHCI_QUIRK_FORCE_DMA)
1228 host->flags |= SDHCI_USE_DMA;
1229 else if ((pdev->class & 0x0000FF) != PCI_SDHCI_IFDMA)
1230 DBG("Controller doesn't have DMA interface\n");
1231 else if (!(caps & SDHCI_CAN_DO_DMA))
1232 DBG("Controller doesn't have DMA capability\n");
1234 host->flags |= SDHCI_USE_DMA;
1236 if (host->flags & SDHCI_USE_DMA) {
1237 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
1238 printk(KERN_WARNING "%s: No suitable DMA available. "
1239 "Falling back to PIO.\n", host->slot_descr);
1240 host->flags &= ~SDHCI_USE_DMA;
1244 if (host->flags & SDHCI_USE_DMA)
1245 pci_set_master(pdev);
1246 else /* XXX: Hack to get MMC layer to avoid highmem */
1250 (caps & SDHCI_CLOCK_BASE_MASK) >> SDHCI_CLOCK_BASE_SHIFT;
1251 if (host->max_clk == 0) {
1252 printk(KERN_ERR "%s: Hardware doesn't specify base clock "
1253 "frequency.\n", host->slot_descr);
1257 host->max_clk *= 1000000;
1260 (caps & SDHCI_TIMEOUT_CLK_MASK) >> SDHCI_TIMEOUT_CLK_SHIFT;
1261 if (host->timeout_clk == 0) {
1262 printk(KERN_ERR "%s: Hardware doesn't specify timeout clock "
1263 "frequency.\n", host->slot_descr);
1267 if (caps & SDHCI_TIMEOUT_CLK_UNIT)
1268 host->timeout_clk *= 1000;
1271 * Set host parameters.
1273 mmc->ops = &sdhci_ops;
1274 mmc->f_min = host->max_clk / 256;
1275 mmc->f_max = host->max_clk;
1276 mmc->caps = MMC_CAP_4_BIT_DATA | MMC_CAP_MULTIWRITE | MMC_CAP_BYTEBLOCK;
1278 if (caps & SDHCI_CAN_DO_HISPD)
1279 mmc->caps |= MMC_CAP_SD_HIGHSPEED;
1282 if (caps & SDHCI_CAN_VDD_330)
1283 mmc->ocr_avail |= MMC_VDD_32_33|MMC_VDD_33_34;
1284 if (caps & SDHCI_CAN_VDD_300)
1285 mmc->ocr_avail |= MMC_VDD_29_30|MMC_VDD_30_31;
1286 if (caps & SDHCI_CAN_VDD_180)
1287 mmc->ocr_avail |= MMC_VDD_17_18|MMC_VDD_18_19;
1289 if (mmc->ocr_avail == 0) {
1290 printk(KERN_ERR "%s: Hardware doesn't report any "
1291 "support voltages.\n", host->slot_descr);
1296 spin_lock_init(&host->lock);
1299 * Maximum number of segments. Hardware cannot do scatter lists.
1301 if (host->flags & SDHCI_USE_DMA)
1302 mmc->max_hw_segs = 1;
1304 mmc->max_hw_segs = 16;
1305 mmc->max_phys_segs = 16;
1308 * Maximum number of sectors in one transfer. Limited by DMA boundary
1311 mmc->max_req_size = 524288;
1314 * Maximum segment size. Could be one segment with the maximum number
1317 mmc->max_seg_size = mmc->max_req_size;
1320 * Maximum block size. This varies from controller to controller and
1321 * is specified in the capabilities register.
1323 mmc->max_blk_size = (caps & SDHCI_MAX_BLOCK_MASK) >> SDHCI_MAX_BLOCK_SHIFT;
1324 if (mmc->max_blk_size >= 3) {
1325 printk(KERN_ERR "%s: Invalid maximum block size.\n",
1330 mmc->max_blk_size = 512 << mmc->max_blk_size;
1333 * Maximum block count.
1335 mmc->max_blk_count = 65535;
1340 tasklet_init(&host->card_tasklet,
1341 sdhci_tasklet_card, (unsigned long)host);
1342 tasklet_init(&host->finish_tasklet,
1343 sdhci_tasklet_finish, (unsigned long)host);
1345 setup_timer(&host->timer, sdhci_timeout_timer, (unsigned long)host);
1347 ret = request_irq(host->irq, sdhci_irq, IRQF_SHARED,
1348 host->slot_descr, host);
1354 #ifdef CONFIG_MMC_DEBUG
1355 sdhci_dumpregs(host);
1362 printk(KERN_INFO "%s: SDHCI at 0x%08lx irq %d %s\n", mmc_hostname(mmc),
1363 host->addr, host->irq,
1364 (host->flags & SDHCI_USE_DMA)?"DMA":"PIO");
1369 tasklet_kill(&host->card_tasklet);
1370 tasklet_kill(&host->finish_tasklet);
1372 iounmap(host->ioaddr);
1374 pci_release_region(pdev, host->bar);
1381 static void sdhci_remove_slot(struct pci_dev *pdev, int slot)
1383 struct sdhci_chip *chip;
1384 struct mmc_host *mmc;
1385 struct sdhci_host *host;
1387 chip = pci_get_drvdata(pdev);
1388 host = chip->hosts[slot];
1391 chip->hosts[slot] = NULL;
1393 mmc_remove_host(mmc);
1395 sdhci_reset(host, SDHCI_RESET_ALL);
1397 free_irq(host->irq, host);
1399 del_timer_sync(&host->timer);
1401 tasklet_kill(&host->card_tasklet);
1402 tasklet_kill(&host->finish_tasklet);
1404 iounmap(host->ioaddr);
1406 pci_release_region(pdev, host->bar);
1411 static int __devinit sdhci_probe(struct pci_dev *pdev,
1412 const struct pci_device_id *ent)
1416 struct sdhci_chip *chip;
1418 BUG_ON(pdev == NULL);
1419 BUG_ON(ent == NULL);
1421 pci_read_config_byte(pdev, PCI_CLASS_REVISION, &rev);
1423 printk(KERN_INFO DRIVER_NAME
1424 ": SDHCI controller found at %s [%04x:%04x] (rev %x)\n",
1425 pci_name(pdev), (int)pdev->vendor, (int)pdev->device,
1428 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &slots);
1432 slots = PCI_SLOT_INFO_SLOTS(slots) + 1;
1433 DBG("found %d slot(s)\n", slots);
1437 ret = pci_enable_device(pdev);
1441 chip = kzalloc(sizeof(struct sdhci_chip) +
1442 sizeof(struct sdhci_host*) * slots, GFP_KERNEL);
1449 chip->quirks = ent->driver_data;
1452 chip->quirks = debug_quirks;
1454 chip->num_slots = slots;
1455 pci_set_drvdata(pdev, chip);
1457 for (i = 0;i < slots;i++) {
1458 ret = sdhci_probe_slot(pdev, i);
1460 for (i--;i >= 0;i--)
1461 sdhci_remove_slot(pdev, i);
1469 pci_set_drvdata(pdev, NULL);
1473 pci_disable_device(pdev);
1477 static void __devexit sdhci_remove(struct pci_dev *pdev)
1480 struct sdhci_chip *chip;
1482 chip = pci_get_drvdata(pdev);
1485 for (i = 0;i < chip->num_slots;i++)
1486 sdhci_remove_slot(pdev, i);
1488 pci_set_drvdata(pdev, NULL);
1493 pci_disable_device(pdev);
1496 static struct pci_driver sdhci_driver = {
1497 .name = DRIVER_NAME,
1498 .id_table = pci_ids,
1499 .probe = sdhci_probe,
1500 .remove = __devexit_p(sdhci_remove),
1501 .suspend = sdhci_suspend,
1502 .resume = sdhci_resume,
1505 /*****************************************************************************\
1507 * Driver init/exit *
1509 \*****************************************************************************/
1511 static int __init sdhci_drv_init(void)
1513 printk(KERN_INFO DRIVER_NAME
1514 ": Secure Digital Host Controller Interface driver\n");
1515 printk(KERN_INFO DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1517 return pci_register_driver(&sdhci_driver);
1520 static void __exit sdhci_drv_exit(void)
1524 pci_unregister_driver(&sdhci_driver);
1527 module_init(sdhci_drv_init);
1528 module_exit(sdhci_drv_exit);
1530 module_param(debug_nodma, uint, 0444);
1531 module_param(debug_forcedma, uint, 0444);
1532 module_param(debug_quirks, uint, 0444);
1534 MODULE_AUTHOR("Pierre Ossman <drzeus@drzeus.cx>");
1535 MODULE_DESCRIPTION("Secure Digital Host Controller Interface driver");
1536 MODULE_LICENSE("GPL");
1538 MODULE_PARM_DESC(debug_nodma, "Forcefully disable DMA transfers. (default 0)");
1539 MODULE_PARM_DESC(debug_forcedma, "Forcefully enable DMA transfers. (default 0)");
1540 MODULE_PARM_DESC(debug_quirks, "Force certain quirks.");