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>
19 #include <asm/scatterlist.h>
23 #define DRIVER_NAME "sdhci"
25 #define DBG(f, x...) \
26 pr_debug(DRIVER_NAME " [%s()]: " f, __func__,## x)
28 static unsigned int debug_nodma = 0;
29 static unsigned int debug_forcedma = 0;
30 static unsigned int debug_quirks = 0;
32 #define SDHCI_QUIRK_CLOCK_BEFORE_RESET (1<<0)
33 #define SDHCI_QUIRK_FORCE_DMA (1<<1)
34 /* Controller doesn't like some resets when there is no card inserted. */
35 #define SDHCI_QUIRK_NO_CARD_NO_RESET (1<<2)
36 #define SDHCI_QUIRK_SINGLE_POWER_WRITE (1<<3)
38 static const struct pci_device_id pci_ids[] __devinitdata = {
40 .vendor = PCI_VENDOR_ID_RICOH,
41 .device = PCI_DEVICE_ID_RICOH_R5C822,
42 .subvendor = PCI_VENDOR_ID_IBM,
43 .subdevice = PCI_ANY_ID,
44 .driver_data = SDHCI_QUIRK_CLOCK_BEFORE_RESET |
45 SDHCI_QUIRK_FORCE_DMA,
49 .vendor = PCI_VENDOR_ID_RICOH,
50 .device = PCI_DEVICE_ID_RICOH_R5C822,
51 .subvendor = PCI_ANY_ID,
52 .subdevice = PCI_ANY_ID,
53 .driver_data = SDHCI_QUIRK_FORCE_DMA |
54 SDHCI_QUIRK_NO_CARD_NO_RESET,
58 .vendor = PCI_VENDOR_ID_TI,
59 .device = PCI_DEVICE_ID_TI_XX21_XX11_SD,
60 .subvendor = PCI_ANY_ID,
61 .subdevice = PCI_ANY_ID,
62 .driver_data = SDHCI_QUIRK_FORCE_DMA,
66 .vendor = PCI_VENDOR_ID_ENE,
67 .device = PCI_DEVICE_ID_ENE_CB712_SD,
68 .subvendor = PCI_ANY_ID,
69 .subdevice = PCI_ANY_ID,
70 .driver_data = SDHCI_QUIRK_SINGLE_POWER_WRITE,
73 { /* Generic SD host controller */
74 PCI_DEVICE_CLASS((PCI_CLASS_SYSTEM_SDHCI << 8), 0xFFFF00)
77 { /* end: all zeroes */ },
80 MODULE_DEVICE_TABLE(pci, pci_ids);
82 static void sdhci_prepare_data(struct sdhci_host *, struct mmc_data *);
83 static void sdhci_finish_data(struct sdhci_host *);
85 static void sdhci_send_command(struct sdhci_host *, struct mmc_command *);
86 static void sdhci_finish_command(struct sdhci_host *);
88 static void sdhci_dumpregs(struct sdhci_host *host)
90 printk(KERN_DEBUG DRIVER_NAME ": ============== REGISTER DUMP ==============\n");
92 printk(KERN_DEBUG DRIVER_NAME ": Sys addr: 0x%08x | Version: 0x%08x\n",
93 readl(host->ioaddr + SDHCI_DMA_ADDRESS),
94 readw(host->ioaddr + SDHCI_HOST_VERSION));
95 printk(KERN_DEBUG DRIVER_NAME ": Blk size: 0x%08x | Blk cnt: 0x%08x\n",
96 readw(host->ioaddr + SDHCI_BLOCK_SIZE),
97 readw(host->ioaddr + SDHCI_BLOCK_COUNT));
98 printk(KERN_DEBUG DRIVER_NAME ": Argument: 0x%08x | Trn mode: 0x%08x\n",
99 readl(host->ioaddr + SDHCI_ARGUMENT),
100 readw(host->ioaddr + SDHCI_TRANSFER_MODE));
101 printk(KERN_DEBUG DRIVER_NAME ": Present: 0x%08x | Host ctl: 0x%08x\n",
102 readl(host->ioaddr + SDHCI_PRESENT_STATE),
103 readb(host->ioaddr + SDHCI_HOST_CONTROL));
104 printk(KERN_DEBUG DRIVER_NAME ": Power: 0x%08x | Blk gap: 0x%08x\n",
105 readb(host->ioaddr + SDHCI_POWER_CONTROL),
106 readb(host->ioaddr + SDHCI_BLOCK_GAP_CONTROL));
107 printk(KERN_DEBUG DRIVER_NAME ": Wake-up: 0x%08x | Clock: 0x%08x\n",
108 readb(host->ioaddr + SDHCI_WALK_UP_CONTROL),
109 readw(host->ioaddr + SDHCI_CLOCK_CONTROL));
110 printk(KERN_DEBUG DRIVER_NAME ": Timeout: 0x%08x | Int stat: 0x%08x\n",
111 readb(host->ioaddr + SDHCI_TIMEOUT_CONTROL),
112 readl(host->ioaddr + SDHCI_INT_STATUS));
113 printk(KERN_DEBUG DRIVER_NAME ": Int enab: 0x%08x | Sig enab: 0x%08x\n",
114 readl(host->ioaddr + SDHCI_INT_ENABLE),
115 readl(host->ioaddr + SDHCI_SIGNAL_ENABLE));
116 printk(KERN_DEBUG DRIVER_NAME ": AC12 err: 0x%08x | Slot int: 0x%08x\n",
117 readw(host->ioaddr + SDHCI_ACMD12_ERR),
118 readw(host->ioaddr + SDHCI_SLOT_INT_STATUS));
119 printk(KERN_DEBUG DRIVER_NAME ": Caps: 0x%08x | Max curr: 0x%08x\n",
120 readl(host->ioaddr + SDHCI_CAPABILITIES),
121 readl(host->ioaddr + SDHCI_MAX_CURRENT));
123 printk(KERN_DEBUG DRIVER_NAME ": ===========================================\n");
126 /*****************************************************************************\
128 * Low level functions *
130 \*****************************************************************************/
132 static void sdhci_reset(struct sdhci_host *host, u8 mask)
134 unsigned long timeout;
136 if (host->chip->quirks & SDHCI_QUIRK_NO_CARD_NO_RESET) {
137 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) &
142 writeb(mask, host->ioaddr + SDHCI_SOFTWARE_RESET);
144 if (mask & SDHCI_RESET_ALL)
147 /* Wait max 100 ms */
150 /* hw clears the bit when it's done */
151 while (readb(host->ioaddr + SDHCI_SOFTWARE_RESET) & mask) {
153 printk(KERN_ERR "%s: Reset 0x%x never completed.\n",
154 mmc_hostname(host->mmc), (int)mask);
155 sdhci_dumpregs(host);
163 static void sdhci_init(struct sdhci_host *host)
167 sdhci_reset(host, SDHCI_RESET_ALL);
169 intmask = SDHCI_INT_BUS_POWER | SDHCI_INT_DATA_END_BIT |
170 SDHCI_INT_DATA_CRC | SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_INDEX |
171 SDHCI_INT_END_BIT | SDHCI_INT_CRC | SDHCI_INT_TIMEOUT |
172 SDHCI_INT_CARD_REMOVE | SDHCI_INT_CARD_INSERT |
173 SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL |
174 SDHCI_INT_DMA_END | SDHCI_INT_DATA_END | SDHCI_INT_RESPONSE;
176 writel(intmask, host->ioaddr + SDHCI_INT_ENABLE);
177 writel(intmask, host->ioaddr + SDHCI_SIGNAL_ENABLE);
180 static void sdhci_activate_led(struct sdhci_host *host)
184 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
185 ctrl |= SDHCI_CTRL_LED;
186 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
189 static void sdhci_deactivate_led(struct sdhci_host *host)
193 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
194 ctrl &= ~SDHCI_CTRL_LED;
195 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
198 /*****************************************************************************\
202 \*****************************************************************************/
204 static inline char* sdhci_sg_to_buffer(struct sdhci_host* host)
206 return page_address(host->cur_sg->page) + host->cur_sg->offset;
209 static inline int sdhci_next_sg(struct sdhci_host* host)
212 * Skip to next SG entry.
220 if (host->num_sg > 0) {
222 host->remain = host->cur_sg->length;
228 static void sdhci_read_block_pio(struct sdhci_host *host)
230 int blksize, chunk_remain;
235 DBG("PIO reading\n");
237 blksize = host->data->blksz;
241 buffer = sdhci_sg_to_buffer(host) + host->offset;
244 if (chunk_remain == 0) {
245 data = readl(host->ioaddr + SDHCI_BUFFER);
246 chunk_remain = min(blksize, 4);
249 size = min(host->remain, chunk_remain);
251 chunk_remain -= size;
253 host->offset += size;
254 host->remain -= size;
257 *buffer = data & 0xFF;
263 if (host->remain == 0) {
264 if (sdhci_next_sg(host) == 0) {
265 BUG_ON(blksize != 0);
268 buffer = sdhci_sg_to_buffer(host);
273 static void sdhci_write_block_pio(struct sdhci_host *host)
275 int blksize, chunk_remain;
280 DBG("PIO writing\n");
282 blksize = host->data->blksz;
287 buffer = sdhci_sg_to_buffer(host) + host->offset;
290 size = min(host->remain, chunk_remain);
292 chunk_remain -= size;
294 host->offset += size;
295 host->remain -= size;
299 data |= (u32)*buffer << 24;
304 if (chunk_remain == 0) {
305 writel(data, host->ioaddr + SDHCI_BUFFER);
306 chunk_remain = min(blksize, 4);
309 if (host->remain == 0) {
310 if (sdhci_next_sg(host) == 0) {
311 BUG_ON(blksize != 0);
314 buffer = sdhci_sg_to_buffer(host);
319 static void sdhci_transfer_pio(struct sdhci_host *host)
325 if (host->num_sg == 0)
328 if (host->data->flags & MMC_DATA_READ)
329 mask = SDHCI_DATA_AVAILABLE;
331 mask = SDHCI_SPACE_AVAILABLE;
333 while (readl(host->ioaddr + SDHCI_PRESENT_STATE) & mask) {
334 if (host->data->flags & MMC_DATA_READ)
335 sdhci_read_block_pio(host);
337 sdhci_write_block_pio(host);
339 if (host->num_sg == 0)
343 DBG("PIO transfer complete.\n");
346 static void sdhci_prepare_data(struct sdhci_host *host, struct mmc_data *data)
349 unsigned target_timeout, current_timeout;
356 DBG("blksz %04x blks %04x flags %08x\n",
357 data->blksz, data->blocks, data->flags);
358 DBG("tsac %d ms nsac %d clk\n",
359 data->timeout_ns / 1000000, data->timeout_clks);
362 BUG_ON(data->blksz * data->blocks > 524288);
363 BUG_ON(data->blksz > host->mmc->max_blk_size);
364 BUG_ON(data->blocks > 65535);
367 target_timeout = data->timeout_ns / 1000 +
368 data->timeout_clks / host->clock;
371 * Figure out needed cycles.
372 * We do this in steps in order to fit inside a 32 bit int.
373 * The first step is the minimum timeout, which will have a
374 * minimum resolution of 6 bits:
375 * (1) 2^13*1000 > 2^22,
376 * (2) host->timeout_clk < 2^16
381 current_timeout = (1 << 13) * 1000 / host->timeout_clk;
382 while (current_timeout < target_timeout) {
384 current_timeout <<= 1;
390 printk(KERN_WARNING "%s: Too large timeout requested!\n",
391 mmc_hostname(host->mmc));
395 writeb(count, host->ioaddr + SDHCI_TIMEOUT_CONTROL);
397 if (host->flags & SDHCI_USE_DMA) {
400 count = pci_map_sg(host->chip->pdev, data->sg, data->sg_len,
401 (data->flags & MMC_DATA_READ)?PCI_DMA_FROMDEVICE:PCI_DMA_TODEVICE);
404 writel(sg_dma_address(data->sg), host->ioaddr + SDHCI_DMA_ADDRESS);
406 host->cur_sg = data->sg;
407 host->num_sg = data->sg_len;
410 host->remain = host->cur_sg->length;
413 /* We do not handle DMA boundaries, so set it to max (512 KiB) */
414 writew(SDHCI_MAKE_BLKSZ(7, data->blksz),
415 host->ioaddr + SDHCI_BLOCK_SIZE);
416 writew(data->blocks, host->ioaddr + SDHCI_BLOCK_COUNT);
419 static void sdhci_set_transfer_mode(struct sdhci_host *host,
420 struct mmc_data *data)
429 mode = SDHCI_TRNS_BLK_CNT_EN;
430 if (data->blocks > 1)
431 mode |= SDHCI_TRNS_MULTI;
432 if (data->flags & MMC_DATA_READ)
433 mode |= SDHCI_TRNS_READ;
434 if (host->flags & SDHCI_USE_DMA)
435 mode |= SDHCI_TRNS_DMA;
437 writew(mode, host->ioaddr + SDHCI_TRANSFER_MODE);
440 static void sdhci_finish_data(struct sdhci_host *host)
442 struct mmc_data *data;
450 if (host->flags & SDHCI_USE_DMA) {
451 pci_unmap_sg(host->chip->pdev, data->sg, data->sg_len,
452 (data->flags & MMC_DATA_READ)?PCI_DMA_FROMDEVICE:PCI_DMA_TODEVICE);
456 * Controller doesn't count down when in single block mode.
458 if ((data->blocks == 1) && (data->error == MMC_ERR_NONE))
461 blocks = readw(host->ioaddr + SDHCI_BLOCK_COUNT);
462 data->bytes_xfered = data->blksz * (data->blocks - blocks);
464 if ((data->error == MMC_ERR_NONE) && blocks) {
465 printk(KERN_ERR "%s: Controller signalled completion even "
466 "though there were blocks left.\n",
467 mmc_hostname(host->mmc));
468 data->error = MMC_ERR_FAILED;
471 DBG("Ending data transfer (%d bytes)\n", data->bytes_xfered);
475 * The controller needs a reset of internal state machines
476 * upon error conditions.
478 if (data->error != MMC_ERR_NONE) {
479 sdhci_reset(host, SDHCI_RESET_CMD);
480 sdhci_reset(host, SDHCI_RESET_DATA);
483 sdhci_send_command(host, data->stop);
485 tasklet_schedule(&host->finish_tasklet);
488 static void sdhci_send_command(struct sdhci_host *host, struct mmc_command *cmd)
492 unsigned long timeout;
496 DBG("Sending cmd (%x)\n", cmd->opcode);
501 mask = SDHCI_CMD_INHIBIT;
502 if ((cmd->data != NULL) || (cmd->flags & MMC_RSP_BUSY))
503 mask |= SDHCI_DATA_INHIBIT;
505 /* We shouldn't wait for data inihibit for stop commands, even
506 though they might use busy signaling */
507 if (host->mrq->data && (cmd == host->mrq->data->stop))
508 mask &= ~SDHCI_DATA_INHIBIT;
510 while (readl(host->ioaddr + SDHCI_PRESENT_STATE) & mask) {
512 printk(KERN_ERR "%s: Controller never released "
513 "inhibit bit(s).\n", mmc_hostname(host->mmc));
514 sdhci_dumpregs(host);
515 cmd->error = MMC_ERR_FAILED;
516 tasklet_schedule(&host->finish_tasklet);
523 mod_timer(&host->timer, jiffies + 10 * HZ);
527 sdhci_prepare_data(host, cmd->data);
529 writel(cmd->arg, host->ioaddr + SDHCI_ARGUMENT);
531 sdhci_set_transfer_mode(host, cmd->data);
533 if ((cmd->flags & MMC_RSP_136) && (cmd->flags & MMC_RSP_BUSY)) {
534 printk(KERN_ERR "%s: Unsupported response type!\n",
535 mmc_hostname(host->mmc));
536 cmd->error = MMC_ERR_INVALID;
537 tasklet_schedule(&host->finish_tasklet);
541 if (!(cmd->flags & MMC_RSP_PRESENT))
542 flags = SDHCI_CMD_RESP_NONE;
543 else if (cmd->flags & MMC_RSP_136)
544 flags = SDHCI_CMD_RESP_LONG;
545 else if (cmd->flags & MMC_RSP_BUSY)
546 flags = SDHCI_CMD_RESP_SHORT_BUSY;
548 flags = SDHCI_CMD_RESP_SHORT;
550 if (cmd->flags & MMC_RSP_CRC)
551 flags |= SDHCI_CMD_CRC;
552 if (cmd->flags & MMC_RSP_OPCODE)
553 flags |= SDHCI_CMD_INDEX;
555 flags |= SDHCI_CMD_DATA;
557 writew(SDHCI_MAKE_CMD(cmd->opcode, flags),
558 host->ioaddr + SDHCI_COMMAND);
561 static void sdhci_finish_command(struct sdhci_host *host)
565 BUG_ON(host->cmd == NULL);
567 if (host->cmd->flags & MMC_RSP_PRESENT) {
568 if (host->cmd->flags & MMC_RSP_136) {
569 /* CRC is stripped so we need to do some shifting. */
570 for (i = 0;i < 4;i++) {
571 host->cmd->resp[i] = readl(host->ioaddr +
572 SDHCI_RESPONSE + (3-i)*4) << 8;
574 host->cmd->resp[i] |=
576 SDHCI_RESPONSE + (3-i)*4-1);
579 host->cmd->resp[0] = readl(host->ioaddr + SDHCI_RESPONSE);
583 host->cmd->error = MMC_ERR_NONE;
585 DBG("Ending cmd (%x)\n", host->cmd->opcode);
588 host->data = host->cmd->data;
590 tasklet_schedule(&host->finish_tasklet);
595 static void sdhci_set_clock(struct sdhci_host *host, unsigned int clock)
599 unsigned long timeout;
601 if (clock == host->clock)
604 writew(0, host->ioaddr + SDHCI_CLOCK_CONTROL);
609 for (div = 1;div < 256;div *= 2) {
610 if ((host->max_clk / div) <= clock)
615 clk = div << SDHCI_DIVIDER_SHIFT;
616 clk |= SDHCI_CLOCK_INT_EN;
617 writew(clk, host->ioaddr + SDHCI_CLOCK_CONTROL);
621 while (!((clk = readw(host->ioaddr + SDHCI_CLOCK_CONTROL))
622 & SDHCI_CLOCK_INT_STABLE)) {
624 printk(KERN_ERR "%s: Internal clock never "
625 "stabilised.\n", mmc_hostname(host->mmc));
626 sdhci_dumpregs(host);
633 clk |= SDHCI_CLOCK_CARD_EN;
634 writew(clk, host->ioaddr + SDHCI_CLOCK_CONTROL);
640 static void sdhci_set_power(struct sdhci_host *host, unsigned short power)
644 if (host->power == power)
647 if (power == (unsigned short)-1) {
648 writeb(0, host->ioaddr + SDHCI_POWER_CONTROL);
653 * Spec says that we should clear the power reg before setting
654 * a new value. Some controllers don't seem to like this though.
656 if (!(host->chip->quirks & SDHCI_QUIRK_SINGLE_POWER_WRITE))
657 writeb(0, host->ioaddr + SDHCI_POWER_CONTROL);
659 pwr = SDHCI_POWER_ON;
661 switch (1 << power) {
664 pwr |= SDHCI_POWER_180;
668 pwr |= SDHCI_POWER_300;
672 pwr |= SDHCI_POWER_330;
678 writeb(pwr, host->ioaddr + SDHCI_POWER_CONTROL);
684 /*****************************************************************************\
688 \*****************************************************************************/
690 static void sdhci_request(struct mmc_host *mmc, struct mmc_request *mrq)
692 struct sdhci_host *host;
695 host = mmc_priv(mmc);
697 spin_lock_irqsave(&host->lock, flags);
699 WARN_ON(host->mrq != NULL);
701 sdhci_activate_led(host);
705 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT)) {
706 host->mrq->cmd->error = MMC_ERR_TIMEOUT;
707 tasklet_schedule(&host->finish_tasklet);
709 sdhci_send_command(host, mrq->cmd);
712 spin_unlock_irqrestore(&host->lock, flags);
715 static void sdhci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
717 struct sdhci_host *host;
721 host = mmc_priv(mmc);
723 spin_lock_irqsave(&host->lock, flags);
726 * Reset the chip on each power off.
727 * Should clear out any weird states.
729 if (ios->power_mode == MMC_POWER_OFF) {
730 writel(0, host->ioaddr + SDHCI_SIGNAL_ENABLE);
734 sdhci_set_clock(host, ios->clock);
736 if (ios->power_mode == MMC_POWER_OFF)
737 sdhci_set_power(host, -1);
739 sdhci_set_power(host, ios->vdd);
741 ctrl = readb(host->ioaddr + SDHCI_HOST_CONTROL);
743 if (ios->bus_width == MMC_BUS_WIDTH_4)
744 ctrl |= SDHCI_CTRL_4BITBUS;
746 ctrl &= ~SDHCI_CTRL_4BITBUS;
748 if (ios->timing == MMC_TIMING_SD_HS)
749 ctrl |= SDHCI_CTRL_HISPD;
751 ctrl &= ~SDHCI_CTRL_HISPD;
753 writeb(ctrl, host->ioaddr + SDHCI_HOST_CONTROL);
756 spin_unlock_irqrestore(&host->lock, flags);
759 static int sdhci_get_ro(struct mmc_host *mmc)
761 struct sdhci_host *host;
765 host = mmc_priv(mmc);
767 spin_lock_irqsave(&host->lock, flags);
769 present = readl(host->ioaddr + SDHCI_PRESENT_STATE);
771 spin_unlock_irqrestore(&host->lock, flags);
773 return !(present & SDHCI_WRITE_PROTECT);
776 static const struct mmc_host_ops sdhci_ops = {
777 .request = sdhci_request,
778 .set_ios = sdhci_set_ios,
779 .get_ro = sdhci_get_ro,
782 /*****************************************************************************\
786 \*****************************************************************************/
788 static void sdhci_tasklet_card(unsigned long param)
790 struct sdhci_host *host;
793 host = (struct sdhci_host*)param;
795 spin_lock_irqsave(&host->lock, flags);
797 if (!(readl(host->ioaddr + SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT)) {
799 printk(KERN_ERR "%s: Card removed during transfer!\n",
800 mmc_hostname(host->mmc));
801 printk(KERN_ERR "%s: Resetting controller.\n",
802 mmc_hostname(host->mmc));
804 sdhci_reset(host, SDHCI_RESET_CMD);
805 sdhci_reset(host, SDHCI_RESET_DATA);
807 host->mrq->cmd->error = MMC_ERR_FAILED;
808 tasklet_schedule(&host->finish_tasklet);
812 spin_unlock_irqrestore(&host->lock, flags);
814 mmc_detect_change(host->mmc, msecs_to_jiffies(500));
817 static void sdhci_tasklet_finish(unsigned long param)
819 struct sdhci_host *host;
821 struct mmc_request *mrq;
823 host = (struct sdhci_host*)param;
825 spin_lock_irqsave(&host->lock, flags);
827 del_timer(&host->timer);
831 DBG("Ending request, cmd (%x)\n", mrq->cmd->opcode);
834 * The controller needs a reset of internal state machines
835 * upon error conditions.
837 if ((mrq->cmd->error != MMC_ERR_NONE) ||
838 (mrq->data && ((mrq->data->error != MMC_ERR_NONE) ||
839 (mrq->data->stop && (mrq->data->stop->error != MMC_ERR_NONE))))) {
841 /* Some controllers need this kick or reset won't work here */
842 if (host->chip->quirks & SDHCI_QUIRK_CLOCK_BEFORE_RESET) {
845 /* This is to force an update */
848 sdhci_set_clock(host, clock);
851 /* Spec says we should do both at the same time, but Ricoh
852 controllers do not like that. */
853 sdhci_reset(host, SDHCI_RESET_CMD);
854 sdhci_reset(host, SDHCI_RESET_DATA);
861 sdhci_deactivate_led(host);
864 spin_unlock_irqrestore(&host->lock, flags);
866 mmc_request_done(host->mmc, mrq);
869 static void sdhci_timeout_timer(unsigned long data)
871 struct sdhci_host *host;
874 host = (struct sdhci_host*)data;
876 spin_lock_irqsave(&host->lock, flags);
879 printk(KERN_ERR "%s: Timeout waiting for hardware "
880 "interrupt.\n", mmc_hostname(host->mmc));
881 sdhci_dumpregs(host);
884 host->data->error = MMC_ERR_TIMEOUT;
885 sdhci_finish_data(host);
888 host->cmd->error = MMC_ERR_TIMEOUT;
890 host->mrq->cmd->error = MMC_ERR_TIMEOUT;
892 tasklet_schedule(&host->finish_tasklet);
897 spin_unlock_irqrestore(&host->lock, flags);
900 /*****************************************************************************\
902 * Interrupt handling *
904 \*****************************************************************************/
906 static void sdhci_cmd_irq(struct sdhci_host *host, u32 intmask)
908 BUG_ON(intmask == 0);
911 printk(KERN_ERR "%s: Got command interrupt even though no "
912 "command operation was in progress.\n",
913 mmc_hostname(host->mmc));
914 sdhci_dumpregs(host);
918 if (intmask & SDHCI_INT_RESPONSE)
919 sdhci_finish_command(host);
921 if (intmask & SDHCI_INT_TIMEOUT)
922 host->cmd->error = MMC_ERR_TIMEOUT;
923 else if (intmask & SDHCI_INT_CRC)
924 host->cmd->error = MMC_ERR_BADCRC;
925 else if (intmask & (SDHCI_INT_END_BIT | SDHCI_INT_INDEX))
926 host->cmd->error = MMC_ERR_FAILED;
928 host->cmd->error = MMC_ERR_INVALID;
930 tasklet_schedule(&host->finish_tasklet);
934 static void sdhci_data_irq(struct sdhci_host *host, u32 intmask)
936 BUG_ON(intmask == 0);
940 * A data end interrupt is sent together with the response
941 * for the stop command.
943 if (intmask & SDHCI_INT_DATA_END)
946 printk(KERN_ERR "%s: Got data interrupt even though no "
947 "data operation was in progress.\n",
948 mmc_hostname(host->mmc));
949 sdhci_dumpregs(host);
954 if (intmask & SDHCI_INT_DATA_TIMEOUT)
955 host->data->error = MMC_ERR_TIMEOUT;
956 else if (intmask & SDHCI_INT_DATA_CRC)
957 host->data->error = MMC_ERR_BADCRC;
958 else if (intmask & SDHCI_INT_DATA_END_BIT)
959 host->data->error = MMC_ERR_FAILED;
961 if (host->data->error != MMC_ERR_NONE)
962 sdhci_finish_data(host);
964 if (intmask & (SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL))
965 sdhci_transfer_pio(host);
967 if (intmask & SDHCI_INT_DATA_END)
968 sdhci_finish_data(host);
972 static irqreturn_t sdhci_irq(int irq, void *dev_id)
975 struct sdhci_host* host = dev_id;
978 spin_lock(&host->lock);
980 intmask = readl(host->ioaddr + SDHCI_INT_STATUS);
982 if (!intmask || intmask == 0xffffffff) {
987 DBG("*** %s got interrupt: 0x%08x\n", host->slot_descr, intmask);
989 if (intmask & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE)) {
990 writel(intmask & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE),
991 host->ioaddr + SDHCI_INT_STATUS);
992 tasklet_schedule(&host->card_tasklet);
995 intmask &= ~(SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE);
997 if (intmask & SDHCI_INT_CMD_MASK) {
998 writel(intmask & SDHCI_INT_CMD_MASK,
999 host->ioaddr + SDHCI_INT_STATUS);
1000 sdhci_cmd_irq(host, intmask & SDHCI_INT_CMD_MASK);
1003 if (intmask & SDHCI_INT_DATA_MASK) {
1004 writel(intmask & SDHCI_INT_DATA_MASK,
1005 host->ioaddr + SDHCI_INT_STATUS);
1006 sdhci_data_irq(host, intmask & SDHCI_INT_DATA_MASK);
1009 intmask &= ~(SDHCI_INT_CMD_MASK | SDHCI_INT_DATA_MASK);
1011 if (intmask & SDHCI_INT_BUS_POWER) {
1012 printk(KERN_ERR "%s: Card is consuming too much power!\n",
1013 mmc_hostname(host->mmc));
1014 writel(SDHCI_INT_BUS_POWER, host->ioaddr + SDHCI_INT_STATUS);
1017 intmask &= SDHCI_INT_BUS_POWER;
1020 printk(KERN_ERR "%s: Unexpected interrupt 0x%08x.\n",
1021 mmc_hostname(host->mmc), intmask);
1022 sdhci_dumpregs(host);
1024 writel(intmask, host->ioaddr + SDHCI_INT_STATUS);
1027 result = IRQ_HANDLED;
1031 spin_unlock(&host->lock);
1036 /*****************************************************************************\
1040 \*****************************************************************************/
1044 static int sdhci_suspend (struct pci_dev *pdev, pm_message_t state)
1046 struct sdhci_chip *chip;
1049 chip = pci_get_drvdata(pdev);
1053 DBG("Suspending...\n");
1055 for (i = 0;i < chip->num_slots;i++) {
1056 if (!chip->hosts[i])
1058 ret = mmc_suspend_host(chip->hosts[i]->mmc, state);
1060 for (i--;i >= 0;i--)
1061 mmc_resume_host(chip->hosts[i]->mmc);
1066 pci_save_state(pdev);
1067 pci_enable_wake(pdev, pci_choose_state(pdev, state), 0);
1069 for (i = 0;i < chip->num_slots;i++) {
1070 if (!chip->hosts[i])
1072 free_irq(chip->hosts[i]->irq, chip->hosts[i]);
1075 pci_disable_device(pdev);
1076 pci_set_power_state(pdev, pci_choose_state(pdev, state));
1081 static int sdhci_resume (struct pci_dev *pdev)
1083 struct sdhci_chip *chip;
1086 chip = pci_get_drvdata(pdev);
1090 DBG("Resuming...\n");
1092 pci_set_power_state(pdev, PCI_D0);
1093 pci_restore_state(pdev);
1094 ret = pci_enable_device(pdev);
1098 for (i = 0;i < chip->num_slots;i++) {
1099 if (!chip->hosts[i])
1101 if (chip->hosts[i]->flags & SDHCI_USE_DMA)
1102 pci_set_master(pdev);
1103 ret = request_irq(chip->hosts[i]->irq, sdhci_irq,
1104 IRQF_SHARED, chip->hosts[i]->slot_descr,
1108 sdhci_init(chip->hosts[i]);
1110 ret = mmc_resume_host(chip->hosts[i]->mmc);
1118 #else /* CONFIG_PM */
1120 #define sdhci_suspend NULL
1121 #define sdhci_resume NULL
1123 #endif /* CONFIG_PM */
1125 /*****************************************************************************\
1127 * Device probing/removal *
1129 \*****************************************************************************/
1131 static int __devinit sdhci_probe_slot(struct pci_dev *pdev, int slot)
1134 unsigned int version;
1135 struct sdhci_chip *chip;
1136 struct mmc_host *mmc;
1137 struct sdhci_host *host;
1142 chip = pci_get_drvdata(pdev);
1145 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &first_bar);
1149 first_bar &= PCI_SLOT_INFO_FIRST_BAR_MASK;
1151 if (first_bar > 5) {
1152 printk(KERN_ERR DRIVER_NAME ": Invalid first BAR. Aborting.\n");
1156 if (!(pci_resource_flags(pdev, first_bar + slot) & IORESOURCE_MEM)) {
1157 printk(KERN_ERR DRIVER_NAME ": BAR is not iomem. Aborting.\n");
1161 if (pci_resource_len(pdev, first_bar + slot) != 0x100) {
1162 printk(KERN_ERR DRIVER_NAME ": Invalid iomem size. "
1163 "You may experience problems.\n");
1166 if ((pdev->class & 0x0000FF) == PCI_SDHCI_IFVENDOR) {
1167 printk(KERN_ERR DRIVER_NAME ": Vendor specific interface. Aborting.\n");
1171 if ((pdev->class & 0x0000FF) > PCI_SDHCI_IFVENDOR) {
1172 printk(KERN_ERR DRIVER_NAME ": Unknown interface. Aborting.\n");
1176 mmc = mmc_alloc_host(sizeof(struct sdhci_host), &pdev->dev);
1180 host = mmc_priv(mmc);
1184 chip->hosts[slot] = host;
1186 host->bar = first_bar + slot;
1188 host->addr = pci_resource_start(pdev, host->bar);
1189 host->irq = pdev->irq;
1191 DBG("slot %d at 0x%08lx, irq %d\n", slot, host->addr, host->irq);
1193 snprintf(host->slot_descr, 20, "sdhci:slot%d", slot);
1195 ret = pci_request_region(pdev, host->bar, host->slot_descr);
1199 host->ioaddr = ioremap_nocache(host->addr,
1200 pci_resource_len(pdev, host->bar));
1201 if (!host->ioaddr) {
1206 sdhci_reset(host, SDHCI_RESET_ALL);
1208 version = readw(host->ioaddr + SDHCI_HOST_VERSION);
1209 version = (version & SDHCI_SPEC_VER_MASK) >> SDHCI_SPEC_VER_SHIFT;
1211 printk(KERN_ERR "%s: Unknown controller version (%d). "
1212 "You may experience problems.\n", host->slot_descr,
1216 caps = readl(host->ioaddr + SDHCI_CAPABILITIES);
1219 DBG("DMA forced off\n");
1220 else if (debug_forcedma) {
1221 DBG("DMA forced on\n");
1222 host->flags |= SDHCI_USE_DMA;
1223 } else if (chip->quirks & SDHCI_QUIRK_FORCE_DMA)
1224 host->flags |= SDHCI_USE_DMA;
1225 else if ((pdev->class & 0x0000FF) != PCI_SDHCI_IFDMA)
1226 DBG("Controller doesn't have DMA interface\n");
1227 else if (!(caps & SDHCI_CAN_DO_DMA))
1228 DBG("Controller doesn't have DMA capability\n");
1230 host->flags |= SDHCI_USE_DMA;
1232 if (host->flags & SDHCI_USE_DMA) {
1233 if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
1234 printk(KERN_WARNING "%s: No suitable DMA available. "
1235 "Falling back to PIO.\n", host->slot_descr);
1236 host->flags &= ~SDHCI_USE_DMA;
1240 if (host->flags & SDHCI_USE_DMA)
1241 pci_set_master(pdev);
1242 else /* XXX: Hack to get MMC layer to avoid highmem */
1246 (caps & SDHCI_CLOCK_BASE_MASK) >> SDHCI_CLOCK_BASE_SHIFT;
1247 if (host->max_clk == 0) {
1248 printk(KERN_ERR "%s: Hardware doesn't specify base clock "
1249 "frequency.\n", host->slot_descr);
1253 host->max_clk *= 1000000;
1256 (caps & SDHCI_TIMEOUT_CLK_MASK) >> SDHCI_TIMEOUT_CLK_SHIFT;
1257 if (host->timeout_clk == 0) {
1258 printk(KERN_ERR "%s: Hardware doesn't specify timeout clock "
1259 "frequency.\n", host->slot_descr);
1263 if (caps & SDHCI_TIMEOUT_CLK_UNIT)
1264 host->timeout_clk *= 1000;
1267 * Set host parameters.
1269 mmc->ops = &sdhci_ops;
1270 mmc->f_min = host->max_clk / 256;
1271 mmc->f_max = host->max_clk;
1272 mmc->caps = MMC_CAP_4_BIT_DATA | MMC_CAP_MULTIWRITE | MMC_CAP_BYTEBLOCK;
1274 if (caps & SDHCI_CAN_DO_HISPD)
1275 mmc->caps |= MMC_CAP_SD_HIGHSPEED;
1278 if (caps & SDHCI_CAN_VDD_330)
1279 mmc->ocr_avail |= MMC_VDD_32_33|MMC_VDD_33_34;
1280 if (caps & SDHCI_CAN_VDD_300)
1281 mmc->ocr_avail |= MMC_VDD_29_30|MMC_VDD_30_31;
1282 if (caps & SDHCI_CAN_VDD_180)
1283 mmc->ocr_avail |= MMC_VDD_17_18|MMC_VDD_18_19;
1285 if (mmc->ocr_avail == 0) {
1286 printk(KERN_ERR "%s: Hardware doesn't report any "
1287 "support voltages.\n", host->slot_descr);
1292 spin_lock_init(&host->lock);
1295 * Maximum number of segments. Hardware cannot do scatter lists.
1297 if (host->flags & SDHCI_USE_DMA)
1298 mmc->max_hw_segs = 1;
1300 mmc->max_hw_segs = 16;
1301 mmc->max_phys_segs = 16;
1304 * Maximum number of sectors in one transfer. Limited by DMA boundary
1307 mmc->max_req_size = 524288;
1310 * Maximum segment size. Could be one segment with the maximum number
1313 mmc->max_seg_size = mmc->max_req_size;
1316 * Maximum block size. This varies from controller to controller and
1317 * is specified in the capabilities register.
1319 mmc->max_blk_size = (caps & SDHCI_MAX_BLOCK_MASK) >> SDHCI_MAX_BLOCK_SHIFT;
1320 if (mmc->max_blk_size >= 3) {
1321 printk(KERN_ERR "%s: Invalid maximum block size.\n",
1326 mmc->max_blk_size = 512 << mmc->max_blk_size;
1329 * Maximum block count.
1331 mmc->max_blk_count = 65535;
1336 tasklet_init(&host->card_tasklet,
1337 sdhci_tasklet_card, (unsigned long)host);
1338 tasklet_init(&host->finish_tasklet,
1339 sdhci_tasklet_finish, (unsigned long)host);
1341 setup_timer(&host->timer, sdhci_timeout_timer, (unsigned long)host);
1343 ret = request_irq(host->irq, sdhci_irq, IRQF_SHARED,
1344 host->slot_descr, host);
1350 #ifdef CONFIG_MMC_DEBUG
1351 sdhci_dumpregs(host);
1358 printk(KERN_INFO "%s: SDHCI at 0x%08lx irq %d %s\n", mmc_hostname(mmc),
1359 host->addr, host->irq,
1360 (host->flags & SDHCI_USE_DMA)?"DMA":"PIO");
1365 tasklet_kill(&host->card_tasklet);
1366 tasklet_kill(&host->finish_tasklet);
1368 iounmap(host->ioaddr);
1370 pci_release_region(pdev, host->bar);
1377 static void sdhci_remove_slot(struct pci_dev *pdev, int slot)
1379 struct sdhci_chip *chip;
1380 struct mmc_host *mmc;
1381 struct sdhci_host *host;
1383 chip = pci_get_drvdata(pdev);
1384 host = chip->hosts[slot];
1387 chip->hosts[slot] = NULL;
1389 mmc_remove_host(mmc);
1391 sdhci_reset(host, SDHCI_RESET_ALL);
1393 free_irq(host->irq, host);
1395 del_timer_sync(&host->timer);
1397 tasklet_kill(&host->card_tasklet);
1398 tasklet_kill(&host->finish_tasklet);
1400 iounmap(host->ioaddr);
1402 pci_release_region(pdev, host->bar);
1407 static int __devinit sdhci_probe(struct pci_dev *pdev,
1408 const struct pci_device_id *ent)
1412 struct sdhci_chip *chip;
1414 BUG_ON(pdev == NULL);
1415 BUG_ON(ent == NULL);
1417 pci_read_config_byte(pdev, PCI_CLASS_REVISION, &rev);
1419 printk(KERN_INFO DRIVER_NAME
1420 ": SDHCI controller found at %s [%04x:%04x] (rev %x)\n",
1421 pci_name(pdev), (int)pdev->vendor, (int)pdev->device,
1424 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &slots);
1428 slots = PCI_SLOT_INFO_SLOTS(slots) + 1;
1429 DBG("found %d slot(s)\n", slots);
1433 ret = pci_enable_device(pdev);
1437 chip = kzalloc(sizeof(struct sdhci_chip) +
1438 sizeof(struct sdhci_host*) * slots, GFP_KERNEL);
1445 chip->quirks = ent->driver_data;
1448 chip->quirks = debug_quirks;
1450 chip->num_slots = slots;
1451 pci_set_drvdata(pdev, chip);
1453 for (i = 0;i < slots;i++) {
1454 ret = sdhci_probe_slot(pdev, i);
1456 for (i--;i >= 0;i--)
1457 sdhci_remove_slot(pdev, i);
1465 pci_set_drvdata(pdev, NULL);
1469 pci_disable_device(pdev);
1473 static void __devexit sdhci_remove(struct pci_dev *pdev)
1476 struct sdhci_chip *chip;
1478 chip = pci_get_drvdata(pdev);
1481 for (i = 0;i < chip->num_slots;i++)
1482 sdhci_remove_slot(pdev, i);
1484 pci_set_drvdata(pdev, NULL);
1489 pci_disable_device(pdev);
1492 static struct pci_driver sdhci_driver = {
1493 .name = DRIVER_NAME,
1494 .id_table = pci_ids,
1495 .probe = sdhci_probe,
1496 .remove = __devexit_p(sdhci_remove),
1497 .suspend = sdhci_suspend,
1498 .resume = sdhci_resume,
1501 /*****************************************************************************\
1503 * Driver init/exit *
1505 \*****************************************************************************/
1507 static int __init sdhci_drv_init(void)
1509 printk(KERN_INFO DRIVER_NAME
1510 ": Secure Digital Host Controller Interface driver\n");
1511 printk(KERN_INFO DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1513 return pci_register_driver(&sdhci_driver);
1516 static void __exit sdhci_drv_exit(void)
1520 pci_unregister_driver(&sdhci_driver);
1523 module_init(sdhci_drv_init);
1524 module_exit(sdhci_drv_exit);
1526 module_param(debug_nodma, uint, 0444);
1527 module_param(debug_forcedma, uint, 0444);
1528 module_param(debug_quirks, uint, 0444);
1530 MODULE_AUTHOR("Pierre Ossman <drzeus@drzeus.cx>");
1531 MODULE_DESCRIPTION("Secure Digital Host Controller Interface driver");
1532 MODULE_LICENSE("GPL");
1534 MODULE_PARM_DESC(debug_nodma, "Forcefully disable DMA transfers. (default 0)");
1535 MODULE_PARM_DESC(debug_forcedma, "Forcefully enable DMA transfers. (default 0)");
1536 MODULE_PARM_DESC(debug_quirks, "Force certain quirks.");