1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * linux/drivers/mmc/host/wbsd.c - Winbond W83L51xD SD/MMC driver
5 * Copyright (C) 2004-2007 Pierre Ossman, All Rights Reserved.
9 * Changes to the FIFO system should be done with extreme care since
10 * the hardware is full of bugs related to the FIFO. Known issues are:
12 * - FIFO size field in FSR is always zero.
14 * - FIFO interrupts tend not to work as they should. Interrupts are
15 * triggered only for full/empty events, not for threshold values.
17 * - On APIC systems the FIFO empty interrupt is sometimes lost.
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/init.h>
23 #include <linux/ioport.h>
24 #include <linux/platform_device.h>
25 #include <linux/interrupt.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/delay.h>
28 #include <linux/pnp.h>
29 #include <linux/highmem.h>
30 #include <linux/mmc/host.h>
31 #include <linux/scatterlist.h>
32 #include <linux/slab.h>
39 #define DRIVER_NAME "wbsd"
42 pr_debug(DRIVER_NAME ": " x)
43 #define DBGF(f, x...) \
44 pr_debug(DRIVER_NAME " [%s()]: " f, __func__ , ##x)
52 static const struct pnp_device_id pnp_dev_table[] = {
58 MODULE_DEVICE_TABLE(pnp, pnp_dev_table);
60 #endif /* CONFIG_PNP */
62 static const int config_ports[] = { 0x2E, 0x4E };
63 static const int unlock_codes[] = { 0x83, 0x87 };
65 static const int valid_ids[] = {
70 static unsigned int param_nopnp = 0;
72 static const unsigned int param_nopnp = 1;
74 static unsigned int param_io = 0x248;
75 static unsigned int param_irq = 6;
76 static int param_dma = 2;
82 static inline void wbsd_unlock_config(struct wbsd_host *host)
84 BUG_ON(host->config == 0);
86 outb(host->unlock_code, host->config);
87 outb(host->unlock_code, host->config);
90 static inline void wbsd_lock_config(struct wbsd_host *host)
92 BUG_ON(host->config == 0);
94 outb(LOCK_CODE, host->config);
97 static inline void wbsd_write_config(struct wbsd_host *host, u8 reg, u8 value)
99 BUG_ON(host->config == 0);
101 outb(reg, host->config);
102 outb(value, host->config + 1);
105 static inline u8 wbsd_read_config(struct wbsd_host *host, u8 reg)
107 BUG_ON(host->config == 0);
109 outb(reg, host->config);
110 return inb(host->config + 1);
113 static inline void wbsd_write_index(struct wbsd_host *host, u8 index, u8 value)
115 outb(index, host->base + WBSD_IDXR);
116 outb(value, host->base + WBSD_DATAR);
119 static inline u8 wbsd_read_index(struct wbsd_host *host, u8 index)
121 outb(index, host->base + WBSD_IDXR);
122 return inb(host->base + WBSD_DATAR);
129 static void wbsd_init_device(struct wbsd_host *host)
134 * Reset chip (SD/MMC part) and fifo.
136 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
137 setup |= WBSD_FIFO_RESET | WBSD_SOFT_RESET;
138 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
143 setup &= ~WBSD_DAT3_H;
144 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
145 host->flags &= ~WBSD_FIGNORE_DETECT;
148 * Read back default clock.
150 host->clk = wbsd_read_index(host, WBSD_IDX_CLK);
155 outb(WBSD_POWER_N, host->base + WBSD_CSR);
158 * Set maximum timeout.
160 wbsd_write_index(host, WBSD_IDX_TAAC, 0x7F);
163 * Test for card presence
165 if (inb(host->base + WBSD_CSR) & WBSD_CARDPRESENT)
166 host->flags |= WBSD_FCARD_PRESENT;
168 host->flags &= ~WBSD_FCARD_PRESENT;
171 * Enable interesting interrupts.
174 ier |= WBSD_EINT_CARD;
175 ier |= WBSD_EINT_FIFO_THRE;
176 ier |= WBSD_EINT_CRC;
177 ier |= WBSD_EINT_TIMEOUT;
180 outb(ier, host->base + WBSD_EIR);
185 inb(host->base + WBSD_ISR);
188 static void wbsd_reset(struct wbsd_host *host)
192 pr_err("%s: Resetting chip\n", mmc_hostname(host->mmc));
195 * Soft reset of chip (SD/MMC part).
197 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
198 setup |= WBSD_SOFT_RESET;
199 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
202 static void wbsd_request_end(struct wbsd_host *host, struct mmc_request *mrq)
204 unsigned long dmaflags;
206 if (host->dma >= 0) {
208 * Release ISA DMA controller.
210 dmaflags = claim_dma_lock();
211 disable_dma(host->dma);
212 clear_dma_ff(host->dma);
213 release_dma_lock(dmaflags);
216 * Disable DMA on host.
218 wbsd_write_index(host, WBSD_IDX_DMA, 0);
224 * MMC layer might call back into the driver so first unlock.
226 spin_unlock(&host->lock);
227 mmc_request_done(host->mmc, mrq);
228 spin_lock(&host->lock);
232 * Scatter/gather functions
235 static inline void wbsd_init_sg(struct wbsd_host *host, struct mmc_data *data)
238 * Get info. about SG list from data structure.
240 host->cur_sg = data->sg;
241 host->num_sg = data->sg_len;
244 host->remain = host->cur_sg->length;
247 static inline int wbsd_next_sg(struct wbsd_host *host)
250 * Skip to next SG entry.
258 if (host->num_sg > 0) {
260 host->remain = host->cur_sg->length;
266 static inline char *wbsd_map_sg(struct wbsd_host *host)
268 return kmap_atomic(sg_page(host->cur_sg)) + host->cur_sg->offset;
271 static inline void wbsd_sg_to_dma(struct wbsd_host *host, struct mmc_data *data)
276 for (i = 0; i < data->sg_len; i++)
277 len += data->sg[i].length;
278 sg_copy_to_buffer(data->sg, data->sg_len, host->dma_buffer, len);
281 static inline void wbsd_dma_to_sg(struct wbsd_host *host, struct mmc_data *data)
286 for (i = 0; i < data->sg_len; i++)
287 len += data->sg[i].length;
288 sg_copy_from_buffer(data->sg, data->sg_len, host->dma_buffer, len);
295 static inline void wbsd_get_short_reply(struct wbsd_host *host,
296 struct mmc_command *cmd)
299 * Correct response type?
301 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_SHORT) {
302 cmd->error = -EILSEQ;
306 cmd->resp[0] = wbsd_read_index(host, WBSD_IDX_RESP12) << 24;
307 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP13) << 16;
308 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP14) << 8;
309 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP15) << 0;
310 cmd->resp[1] = wbsd_read_index(host, WBSD_IDX_RESP16) << 24;
313 static inline void wbsd_get_long_reply(struct wbsd_host *host,
314 struct mmc_command *cmd)
319 * Correct response type?
321 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_LONG) {
322 cmd->error = -EILSEQ;
326 for (i = 0; i < 4; i++) {
328 wbsd_read_index(host, WBSD_IDX_RESP1 + i * 4) << 24;
330 wbsd_read_index(host, WBSD_IDX_RESP2 + i * 4) << 16;
332 wbsd_read_index(host, WBSD_IDX_RESP3 + i * 4) << 8;
334 wbsd_read_index(host, WBSD_IDX_RESP4 + i * 4) << 0;
338 static void wbsd_send_command(struct wbsd_host *host, struct mmc_command *cmd)
344 * Clear accumulated ISR. The interrupt routine
345 * will fill this one with events that occur during
351 * Send the command (CRC calculated by host).
353 outb(cmd->opcode, host->base + WBSD_CMDR);
354 for (i = 3; i >= 0; i--)
355 outb((cmd->arg >> (i * 8)) & 0xff, host->base + WBSD_CMDR);
360 * Wait for the request to complete.
363 status = wbsd_read_index(host, WBSD_IDX_STATUS);
364 } while (status & WBSD_CARDTRAFFIC);
367 * Do we expect a reply?
369 if (cmd->flags & MMC_RSP_PRESENT) {
376 if (isr & WBSD_INT_CARD)
377 cmd->error = -ENOMEDIUM;
379 else if (isr & WBSD_INT_TIMEOUT)
380 cmd->error = -ETIMEDOUT;
382 else if ((cmd->flags & MMC_RSP_CRC) && (isr & WBSD_INT_CRC))
383 cmd->error = -EILSEQ;
386 if (cmd->flags & MMC_RSP_136)
387 wbsd_get_long_reply(host, cmd);
389 wbsd_get_short_reply(host, cmd);
398 static void wbsd_empty_fifo(struct wbsd_host *host)
400 struct mmc_data *data = host->mrq->cmd->data;
402 int i, idx, fsr, fifo;
405 * Handle excessive data.
407 if (host->num_sg == 0)
410 buffer = wbsd_map_sg(host) + host->offset;
414 * Drain the fifo. This has a tendency to loop longer
415 * than the FIFO length (usually one block).
417 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_EMPTY)) {
419 * The size field in the FSR is broken so we have to
422 if (fsr & WBSD_FIFO_FULL)
424 else if (fsr & WBSD_FIFO_FUTHRE)
429 for (i = 0; i < fifo; i++) {
430 buffer[idx++] = inb(host->base + WBSD_DFR);
434 data->bytes_xfered++;
437 * End of scatter list entry?
439 if (host->remain == 0) {
440 kunmap_atomic(buffer);
442 * Get next entry. Check if last.
444 if (!wbsd_next_sg(host))
447 buffer = wbsd_map_sg(host);
452 kunmap_atomic(buffer);
455 * This is a very dirty hack to solve a
456 * hardware problem. The chip doesn't trigger
457 * FIFO threshold interrupts properly.
459 if ((data->blocks * data->blksz - data->bytes_xfered) < 16)
460 tasklet_schedule(&host->fifo_tasklet);
463 static void wbsd_fill_fifo(struct wbsd_host *host)
465 struct mmc_data *data = host->mrq->cmd->data;
467 int i, idx, fsr, fifo;
470 * Check that we aren't being called after the
471 * entire buffer has been transferred.
473 if (host->num_sg == 0)
476 buffer = wbsd_map_sg(host) + host->offset;
480 * Fill the fifo. This has a tendency to loop longer
481 * than the FIFO length (usually one block).
483 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_FULL)) {
485 * The size field in the FSR is broken so we have to
488 if (fsr & WBSD_FIFO_EMPTY)
490 else if (fsr & WBSD_FIFO_EMTHRE)
495 for (i = 16; i > fifo; i--) {
496 outb(buffer[idx], host->base + WBSD_DFR);
500 data->bytes_xfered++;
503 * End of scatter list entry?
505 if (host->remain == 0) {
506 kunmap_atomic(buffer);
508 * Get next entry. Check if last.
510 if (!wbsd_next_sg(host))
513 buffer = wbsd_map_sg(host);
518 kunmap_atomic(buffer);
521 * The controller stops sending interrupts for
522 * 'FIFO empty' under certain conditions. So we
523 * need to be a bit more pro-active.
525 tasklet_schedule(&host->fifo_tasklet);
528 static void wbsd_prepare_data(struct wbsd_host *host, struct mmc_data *data)
532 unsigned long dmaflags;
538 size = data->blocks * data->blksz;
541 * Check timeout values for overflow.
542 * (Yes, some cards cause this value to overflow).
544 if (data->timeout_ns > 127000000)
545 wbsd_write_index(host, WBSD_IDX_TAAC, 127);
547 wbsd_write_index(host, WBSD_IDX_TAAC,
548 data->timeout_ns / 1000000);
551 if (data->timeout_clks > 255)
552 wbsd_write_index(host, WBSD_IDX_NSAC, 255);
554 wbsd_write_index(host, WBSD_IDX_NSAC, data->timeout_clks);
557 * Inform the chip of how large blocks will be
558 * sent. It needs this to determine when to
561 * Space for CRC must be included in the size.
562 * Two bytes are needed for each data line.
564 if (host->bus_width == MMC_BUS_WIDTH_1) {
565 blksize = data->blksz + 2;
567 wbsd_write_index(host, WBSD_IDX_PBSMSB, (blksize >> 4) & 0xF0);
568 wbsd_write_index(host, WBSD_IDX_PBSLSB, blksize & 0xFF);
569 } else if (host->bus_width == MMC_BUS_WIDTH_4) {
570 blksize = data->blksz + 2 * 4;
572 wbsd_write_index(host, WBSD_IDX_PBSMSB,
573 ((blksize >> 4) & 0xF0) | WBSD_DATA_WIDTH);
574 wbsd_write_index(host, WBSD_IDX_PBSLSB, blksize & 0xFF);
576 data->error = -EINVAL;
581 * Clear the FIFO. This is needed even for DMA
582 * transfers since the chip still uses the FIFO
585 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
586 setup |= WBSD_FIFO_RESET;
587 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
592 if (host->dma >= 0) {
594 * The buffer for DMA is only 64 kB.
596 BUG_ON(size > 0x10000);
597 if (size > 0x10000) {
598 data->error = -EINVAL;
603 * Transfer data from the SG list to
606 if (data->flags & MMC_DATA_WRITE)
607 wbsd_sg_to_dma(host, data);
610 * Initialise the ISA DMA controller.
612 dmaflags = claim_dma_lock();
613 disable_dma(host->dma);
614 clear_dma_ff(host->dma);
615 if (data->flags & MMC_DATA_READ)
616 set_dma_mode(host->dma, DMA_MODE_READ & ~0x40);
618 set_dma_mode(host->dma, DMA_MODE_WRITE & ~0x40);
619 set_dma_addr(host->dma, host->dma_addr);
620 set_dma_count(host->dma, size);
622 enable_dma(host->dma);
623 release_dma_lock(dmaflags);
626 * Enable DMA on the host.
628 wbsd_write_index(host, WBSD_IDX_DMA, WBSD_DMA_ENABLE);
631 * This flag is used to keep printk
632 * output to a minimum.
637 * Initialise the SG list.
639 wbsd_init_sg(host, data);
644 wbsd_write_index(host, WBSD_IDX_DMA, 0);
647 * Set up FIFO threshold levels (and fill
648 * buffer if doing a write).
650 if (data->flags & MMC_DATA_READ) {
651 wbsd_write_index(host, WBSD_IDX_FIFOEN,
652 WBSD_FIFOEN_FULL | 8);
654 wbsd_write_index(host, WBSD_IDX_FIFOEN,
655 WBSD_FIFOEN_EMPTY | 8);
656 wbsd_fill_fifo(host);
663 static void wbsd_finish_data(struct wbsd_host *host, struct mmc_data *data)
665 unsigned long dmaflags;
669 WARN_ON(host->mrq == NULL);
672 * Send a stop command if needed.
675 wbsd_send_command(host, data->stop);
678 * Wait for the controller to leave data
682 status = wbsd_read_index(host, WBSD_IDX_STATUS);
683 } while (status & (WBSD_BLOCK_READ | WBSD_BLOCK_WRITE));
688 if (host->dma >= 0) {
690 * Disable DMA on the host.
692 wbsd_write_index(host, WBSD_IDX_DMA, 0);
695 * Turn of ISA DMA controller.
697 dmaflags = claim_dma_lock();
698 disable_dma(host->dma);
699 clear_dma_ff(host->dma);
700 count = get_dma_residue(host->dma);
701 release_dma_lock(dmaflags);
703 data->bytes_xfered = host->mrq->data->blocks *
704 host->mrq->data->blksz - count;
705 data->bytes_xfered -= data->bytes_xfered % data->blksz;
711 pr_err("%s: Incomplete DMA transfer. "
713 mmc_hostname(host->mmc), count);
719 * Transfer data from DMA buffer to
722 if (data->flags & MMC_DATA_READ)
723 wbsd_dma_to_sg(host, data);
727 if (data->bytes_xfered)
728 data->bytes_xfered -= data->blksz;
732 wbsd_request_end(host, host->mrq);
735 /*****************************************************************************\
737 * MMC layer callbacks *
739 \*****************************************************************************/
741 static void wbsd_request(struct mmc_host *mmc, struct mmc_request *mrq)
743 struct wbsd_host *host = mmc_priv(mmc);
744 struct mmc_command *cmd;
747 * Disable tasklets to avoid a deadlock.
749 spin_lock_bh(&host->lock);
751 BUG_ON(host->mrq != NULL);
758 * Check that there is actually a card in the slot.
760 if (!(host->flags & WBSD_FCARD_PRESENT)) {
761 cmd->error = -ENOMEDIUM;
767 * The hardware is so delightfully stupid that it has a list
768 * of "data" commands. If a command isn't on this list, it'll
769 * just go back to the idle state and won't send any data
772 switch (cmd->opcode) {
786 /* ACMDs. We don't keep track of state, so we just treat them
787 * like any other command. */
792 pr_warn("%s: Data command %d is not supported by this controller\n",
793 mmc_hostname(host->mmc), cmd->opcode);
794 cmd->error = -EINVAL;
801 * Does the request include data?
804 wbsd_prepare_data(host, cmd->data);
806 if (cmd->data->error)
810 wbsd_send_command(host, cmd);
813 * If this is a data transfer the request
814 * will be finished after the data has
817 if (cmd->data && !cmd->error) {
819 * Dirty fix for hardware bug.
822 tasklet_schedule(&host->fifo_tasklet);
824 spin_unlock_bh(&host->lock);
830 wbsd_request_end(host, mrq);
832 spin_unlock_bh(&host->lock);
835 static void wbsd_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
837 struct wbsd_host *host = mmc_priv(mmc);
840 spin_lock_bh(&host->lock);
843 * Reset the chip on each power off.
844 * Should clear out any weird states.
846 if (ios->power_mode == MMC_POWER_OFF)
847 wbsd_init_device(host);
849 if (ios->clock >= 24000000)
851 else if (ios->clock >= 16000000)
853 else if (ios->clock >= 12000000)
859 * Only write to the clock register when
860 * there is an actual change.
862 if (clk != host->clk) {
863 wbsd_write_index(host, WBSD_IDX_CLK, clk);
870 if (ios->power_mode != MMC_POWER_OFF) {
871 pwr = inb(host->base + WBSD_CSR);
872 pwr &= ~WBSD_POWER_N;
873 outb(pwr, host->base + WBSD_CSR);
877 * MMC cards need to have pin 1 high during init.
878 * It wreaks havoc with the card detection though so
879 * that needs to be disabled.
881 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
882 if (ios->chip_select == MMC_CS_HIGH) {
883 BUG_ON(ios->bus_width != MMC_BUS_WIDTH_1);
884 setup |= WBSD_DAT3_H;
885 host->flags |= WBSD_FIGNORE_DETECT;
887 if (setup & WBSD_DAT3_H) {
888 setup &= ~WBSD_DAT3_H;
891 * We cannot resume card detection immediately
892 * because of capacitance and delays in the chip.
894 mod_timer(&host->ignore_timer, jiffies + HZ / 100);
897 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
900 * Store bus width for later. Will be used when
901 * setting up the data transfer.
903 host->bus_width = ios->bus_width;
905 spin_unlock_bh(&host->lock);
908 static int wbsd_get_ro(struct mmc_host *mmc)
910 struct wbsd_host *host = mmc_priv(mmc);
913 spin_lock_bh(&host->lock);
915 csr = inb(host->base + WBSD_CSR);
917 outb(csr, host->base + WBSD_CSR);
921 csr = inb(host->base + WBSD_CSR);
923 outb(csr, host->base + WBSD_CSR);
925 spin_unlock_bh(&host->lock);
927 return !!(csr & WBSD_WRPT);
930 static const struct mmc_host_ops wbsd_ops = {
931 .request = wbsd_request,
932 .set_ios = wbsd_set_ios,
933 .get_ro = wbsd_get_ro,
936 /*****************************************************************************\
938 * Interrupt handling *
940 \*****************************************************************************/
943 * Helper function to reset detection ignore
946 static void wbsd_reset_ignore(struct timer_list *t)
948 struct wbsd_host *host = from_timer(host, t, ignore_timer);
950 BUG_ON(host == NULL);
952 DBG("Resetting card detection ignore\n");
954 spin_lock_bh(&host->lock);
956 host->flags &= ~WBSD_FIGNORE_DETECT;
959 * Card status might have changed during the
962 tasklet_schedule(&host->card_tasklet);
964 spin_unlock_bh(&host->lock);
971 static inline struct mmc_data *wbsd_get_data(struct wbsd_host *host)
977 WARN_ON(!host->mrq->cmd);
981 WARN_ON(!host->mrq->cmd->data);
982 if (!host->mrq->cmd->data)
985 return host->mrq->cmd->data;
988 static void wbsd_tasklet_card(unsigned long param)
990 struct wbsd_host *host = (struct wbsd_host *)param;
994 spin_lock(&host->lock);
996 if (host->flags & WBSD_FIGNORE_DETECT) {
997 spin_unlock(&host->lock);
1001 csr = inb(host->base + WBSD_CSR);
1002 WARN_ON(csr == 0xff);
1004 if (csr & WBSD_CARDPRESENT) {
1005 if (!(host->flags & WBSD_FCARD_PRESENT)) {
1006 DBG("Card inserted\n");
1007 host->flags |= WBSD_FCARD_PRESENT;
1011 } else if (host->flags & WBSD_FCARD_PRESENT) {
1012 DBG("Card removed\n");
1013 host->flags &= ~WBSD_FCARD_PRESENT;
1016 pr_err("%s: Card removed during transfer!\n",
1017 mmc_hostname(host->mmc));
1020 host->mrq->cmd->error = -ENOMEDIUM;
1021 tasklet_schedule(&host->finish_tasklet);
1028 * Unlock first since we might get a call back.
1031 spin_unlock(&host->lock);
1034 mmc_detect_change(host->mmc, msecs_to_jiffies(delay));
1037 static void wbsd_tasklet_fifo(unsigned long param)
1039 struct wbsd_host *host = (struct wbsd_host *)param;
1040 struct mmc_data *data;
1042 spin_lock(&host->lock);
1047 data = wbsd_get_data(host);
1051 if (data->flags & MMC_DATA_WRITE)
1052 wbsd_fill_fifo(host);
1054 wbsd_empty_fifo(host);
1059 if (host->num_sg == 0) {
1060 wbsd_write_index(host, WBSD_IDX_FIFOEN, 0);
1061 tasklet_schedule(&host->finish_tasklet);
1065 spin_unlock(&host->lock);
1068 static void wbsd_tasklet_crc(unsigned long param)
1070 struct wbsd_host *host = (struct wbsd_host *)param;
1071 struct mmc_data *data;
1073 spin_lock(&host->lock);
1078 data = wbsd_get_data(host);
1082 DBGF("CRC error\n");
1084 data->error = -EILSEQ;
1086 tasklet_schedule(&host->finish_tasklet);
1089 spin_unlock(&host->lock);
1092 static void wbsd_tasklet_timeout(unsigned long param)
1094 struct wbsd_host *host = (struct wbsd_host *)param;
1095 struct mmc_data *data;
1097 spin_lock(&host->lock);
1102 data = wbsd_get_data(host);
1108 data->error = -ETIMEDOUT;
1110 tasklet_schedule(&host->finish_tasklet);
1113 spin_unlock(&host->lock);
1116 static void wbsd_tasklet_finish(unsigned long param)
1118 struct wbsd_host *host = (struct wbsd_host *)param;
1119 struct mmc_data *data;
1121 spin_lock(&host->lock);
1123 WARN_ON(!host->mrq);
1127 data = wbsd_get_data(host);
1131 wbsd_finish_data(host, data);
1134 spin_unlock(&host->lock);
1138 * Interrupt handling
1141 static irqreturn_t wbsd_irq(int irq, void *dev_id)
1143 struct wbsd_host *host = dev_id;
1146 isr = inb(host->base + WBSD_ISR);
1149 * Was it actually our hardware that caused the interrupt?
1151 if (isr == 0xff || isr == 0x00)
1157 * Schedule tasklets as needed.
1159 if (isr & WBSD_INT_CARD)
1160 tasklet_schedule(&host->card_tasklet);
1161 if (isr & WBSD_INT_FIFO_THRE)
1162 tasklet_schedule(&host->fifo_tasklet);
1163 if (isr & WBSD_INT_CRC)
1164 tasklet_hi_schedule(&host->crc_tasklet);
1165 if (isr & WBSD_INT_TIMEOUT)
1166 tasklet_hi_schedule(&host->timeout_tasklet);
1167 if (isr & WBSD_INT_TC)
1168 tasklet_schedule(&host->finish_tasklet);
1173 /*****************************************************************************\
1175 * Device initialisation and shutdown *
1177 \*****************************************************************************/
1180 * Allocate/free MMC structure.
1183 static int wbsd_alloc_mmc(struct device *dev)
1185 struct mmc_host *mmc;
1186 struct wbsd_host *host;
1189 * Allocate MMC structure.
1191 mmc = mmc_alloc_host(sizeof(struct wbsd_host), dev);
1195 host = mmc_priv(mmc);
1201 * Set host parameters.
1203 mmc->ops = &wbsd_ops;
1204 mmc->f_min = 375000;
1205 mmc->f_max = 24000000;
1206 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
1207 mmc->caps = MMC_CAP_4_BIT_DATA;
1209 spin_lock_init(&host->lock);
1214 timer_setup(&host->ignore_timer, wbsd_reset_ignore, 0);
1217 * Maximum number of segments. Worst case is one sector per segment
1218 * so this will be 64kB/512.
1220 mmc->max_segs = 128;
1223 * Maximum request size. Also limited by 64KiB buffer.
1225 mmc->max_req_size = 65536;
1228 * Maximum segment size. Could be one segment with the maximum number
1231 mmc->max_seg_size = mmc->max_req_size;
1234 * Maximum block size. We have 12 bits (= 4095) but have to subtract
1235 * space for CRC. So the maximum is 4095 - 4*2 = 4087.
1237 mmc->max_blk_size = 4087;
1240 * Maximum block count. There is no real limit so the maximum
1241 * request size will be the only restriction.
1243 mmc->max_blk_count = mmc->max_req_size;
1245 dev_set_drvdata(dev, mmc);
1250 static void wbsd_free_mmc(struct device *dev)
1252 struct mmc_host *mmc;
1253 struct wbsd_host *host;
1255 mmc = dev_get_drvdata(dev);
1259 host = mmc_priv(mmc);
1260 BUG_ON(host == NULL);
1262 del_timer_sync(&host->ignore_timer);
1266 dev_set_drvdata(dev, NULL);
1270 * Scan for known chip id:s
1273 static int wbsd_scan(struct wbsd_host *host)
1279 * Iterate through all ports, all codes to
1280 * find hardware that is in our known list.
1282 for (i = 0; i < ARRAY_SIZE(config_ports); i++) {
1283 if (!request_region(config_ports[i], 2, DRIVER_NAME))
1286 for (j = 0; j < ARRAY_SIZE(unlock_codes); j++) {
1289 host->config = config_ports[i];
1290 host->unlock_code = unlock_codes[j];
1292 wbsd_unlock_config(host);
1294 outb(WBSD_CONF_ID_HI, config_ports[i]);
1295 id = inb(config_ports[i] + 1) << 8;
1297 outb(WBSD_CONF_ID_LO, config_ports[i]);
1298 id |= inb(config_ports[i] + 1);
1300 wbsd_lock_config(host);
1302 for (k = 0; k < ARRAY_SIZE(valid_ids); k++) {
1303 if (id == valid_ids[k]) {
1311 DBG("Unknown hardware (id %x) found at %x\n",
1312 id, config_ports[i]);
1316 release_region(config_ports[i], 2);
1320 host->unlock_code = 0;
1326 * Allocate/free io port ranges
1329 static int wbsd_request_region(struct wbsd_host *host, int base)
1334 if (!request_region(base, 8, DRIVER_NAME))
1342 static void wbsd_release_regions(struct wbsd_host *host)
1345 release_region(host->base, 8);
1350 release_region(host->config, 2);
1356 * Allocate/free DMA port and buffer
1359 static void wbsd_request_dma(struct wbsd_host *host, int dma)
1364 if (request_dma(dma, DRIVER_NAME))
1368 * We need to allocate a special buffer in
1369 * order for ISA to be able to DMA to it.
1371 host->dma_buffer = kmalloc(WBSD_DMA_SIZE,
1372 GFP_NOIO | GFP_DMA | __GFP_RETRY_MAYFAIL | __GFP_NOWARN);
1373 if (!host->dma_buffer)
1377 * Translate the address to a physical address.
1379 host->dma_addr = dma_map_single(mmc_dev(host->mmc), host->dma_buffer,
1380 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1381 if (dma_mapping_error(mmc_dev(host->mmc), host->dma_addr))
1385 * ISA DMA must be aligned on a 64k basis.
1387 if ((host->dma_addr & 0xffff) != 0)
1390 * ISA cannot access memory above 16 MB.
1392 else if (host->dma_addr >= 0x1000000)
1401 * If we've gotten here then there is some kind of alignment bug
1405 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1406 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1410 kfree(host->dma_buffer);
1411 host->dma_buffer = NULL;
1417 pr_warn(DRIVER_NAME ": Unable to allocate DMA %d - falling back on FIFO\n",
1421 static void wbsd_release_dma(struct wbsd_host *host)
1424 * host->dma_addr is valid here iff host->dma_buffer is not NULL.
1426 if (host->dma_buffer) {
1427 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1428 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1429 kfree(host->dma_buffer);
1432 free_dma(host->dma);
1435 host->dma_buffer = NULL;
1440 * Allocate/free IRQ.
1443 static int wbsd_request_irq(struct wbsd_host *host, int irq)
1448 * Set up tasklets. Must be done before requesting interrupt.
1450 tasklet_init(&host->card_tasklet, wbsd_tasklet_card,
1451 (unsigned long)host);
1452 tasklet_init(&host->fifo_tasklet, wbsd_tasklet_fifo,
1453 (unsigned long)host);
1454 tasklet_init(&host->crc_tasklet, wbsd_tasklet_crc,
1455 (unsigned long)host);
1456 tasklet_init(&host->timeout_tasklet, wbsd_tasklet_timeout,
1457 (unsigned long)host);
1458 tasklet_init(&host->finish_tasklet, wbsd_tasklet_finish,
1459 (unsigned long)host);
1462 * Allocate interrupt.
1464 ret = request_irq(irq, wbsd_irq, IRQF_SHARED, DRIVER_NAME, host);
1473 static void wbsd_release_irq(struct wbsd_host *host)
1478 free_irq(host->irq, host);
1482 tasklet_kill(&host->card_tasklet);
1483 tasklet_kill(&host->fifo_tasklet);
1484 tasklet_kill(&host->crc_tasklet);
1485 tasklet_kill(&host->timeout_tasklet);
1486 tasklet_kill(&host->finish_tasklet);
1490 * Allocate all resources for the host.
1493 static int wbsd_request_resources(struct wbsd_host *host,
1494 int base, int irq, int dma)
1499 * Allocate I/O ports.
1501 ret = wbsd_request_region(host, base);
1506 * Allocate interrupt.
1508 ret = wbsd_request_irq(host, irq);
1515 wbsd_request_dma(host, dma);
1521 * Release all resources for the host.
1524 static void wbsd_release_resources(struct wbsd_host *host)
1526 wbsd_release_dma(host);
1527 wbsd_release_irq(host);
1528 wbsd_release_regions(host);
1532 * Configure the resources the chip should use.
1535 static void wbsd_chip_config(struct wbsd_host *host)
1537 wbsd_unlock_config(host);
1542 wbsd_write_config(host, WBSD_CONF_SWRST, 1);
1543 wbsd_write_config(host, WBSD_CONF_SWRST, 0);
1546 * Select SD/MMC function.
1548 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1551 * Set up card detection.
1553 wbsd_write_config(host, WBSD_CONF_PINS, WBSD_PINS_DETECT_GP11);
1558 wbsd_write_config(host, WBSD_CONF_PORT_HI, host->base >> 8);
1559 wbsd_write_config(host, WBSD_CONF_PORT_LO, host->base & 0xff);
1561 wbsd_write_config(host, WBSD_CONF_IRQ, host->irq);
1564 wbsd_write_config(host, WBSD_CONF_DRQ, host->dma);
1567 * Enable and power up chip.
1569 wbsd_write_config(host, WBSD_CONF_ENABLE, 1);
1570 wbsd_write_config(host, WBSD_CONF_POWER, 0x20);
1572 wbsd_lock_config(host);
1576 * Check that configured resources are correct.
1579 static int wbsd_chip_validate(struct wbsd_host *host)
1583 wbsd_unlock_config(host);
1586 * Select SD/MMC function.
1588 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1591 * Read configuration.
1593 base = wbsd_read_config(host, WBSD_CONF_PORT_HI) << 8;
1594 base |= wbsd_read_config(host, WBSD_CONF_PORT_LO);
1596 irq = wbsd_read_config(host, WBSD_CONF_IRQ);
1598 dma = wbsd_read_config(host, WBSD_CONF_DRQ);
1600 wbsd_lock_config(host);
1603 * Validate against given configuration.
1605 if (base != host->base)
1607 if (irq != host->irq)
1609 if ((dma != host->dma) && (host->dma != -1))
1616 * Powers down the SD function
1619 static void wbsd_chip_poweroff(struct wbsd_host *host)
1621 wbsd_unlock_config(host);
1623 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1624 wbsd_write_config(host, WBSD_CONF_ENABLE, 0);
1626 wbsd_lock_config(host);
1629 /*****************************************************************************\
1631 * Devices setup and shutdown *
1633 \*****************************************************************************/
1635 static int wbsd_init(struct device *dev, int base, int irq, int dma,
1638 struct wbsd_host *host = NULL;
1639 struct mmc_host *mmc = NULL;
1642 ret = wbsd_alloc_mmc(dev);
1646 mmc = dev_get_drvdata(dev);
1647 host = mmc_priv(mmc);
1650 * Scan for hardware.
1652 ret = wbsd_scan(host);
1654 if (pnp && (ret == -ENODEV)) {
1655 pr_warn(DRIVER_NAME ": Unable to confirm device presence - you may experience lock-ups\n");
1663 * Request resources.
1665 ret = wbsd_request_resources(host, base, irq, dma);
1667 wbsd_release_resources(host);
1673 * See if chip needs to be configured.
1676 if ((host->config != 0) && !wbsd_chip_validate(host)) {
1677 pr_warn(DRIVER_NAME ": PnP active but chip not configured! You probably have a buggy BIOS. Configuring chip manually.\n");
1678 wbsd_chip_config(host);
1681 wbsd_chip_config(host);
1684 * Power Management stuff. No idea how this works.
1689 wbsd_unlock_config(host);
1690 wbsd_write_config(host, WBSD_CONF_PME, 0xA0);
1691 wbsd_lock_config(host);
1695 * Allow device to initialise itself properly.
1700 * Reset the chip into a known state.
1702 wbsd_init_device(host);
1706 pr_info("%s: W83L51xD", mmc_hostname(mmc));
1707 if (host->chip_id != 0)
1708 printk(" id %x", (int)host->chip_id);
1709 printk(" at 0x%x irq %d", (int)host->base, (int)host->irq);
1711 printk(" dma %d", (int)host->dma);
1721 static void wbsd_shutdown(struct device *dev, int pnp)
1723 struct mmc_host *mmc = dev_get_drvdata(dev);
1724 struct wbsd_host *host;
1729 host = mmc_priv(mmc);
1731 mmc_remove_host(mmc);
1734 * Power down the SD/MMC function.
1737 wbsd_chip_poweroff(host);
1739 wbsd_release_resources(host);
1748 static int wbsd_probe(struct platform_device *dev)
1750 /* Use the module parameters for resources */
1751 return wbsd_init(&dev->dev, param_io, param_irq, param_dma, 0);
1754 static int wbsd_remove(struct platform_device *dev)
1756 wbsd_shutdown(&dev->dev, 0);
1768 wbsd_pnp_probe(struct pnp_dev *pnpdev, const struct pnp_device_id *dev_id)
1773 * Get resources from PnP layer.
1775 io = pnp_port_start(pnpdev, 0);
1776 irq = pnp_irq(pnpdev, 0);
1777 if (pnp_dma_valid(pnpdev, 0))
1778 dma = pnp_dma(pnpdev, 0);
1782 DBGF("PnP resources: port %3x irq %d dma %d\n", io, irq, dma);
1784 return wbsd_init(&pnpdev->dev, io, irq, dma, 1);
1787 static void wbsd_pnp_remove(struct pnp_dev *dev)
1789 wbsd_shutdown(&dev->dev, 1);
1792 #endif /* CONFIG_PNP */
1800 static int wbsd_platform_suspend(struct platform_device *dev,
1803 struct mmc_host *mmc = platform_get_drvdata(dev);
1804 struct wbsd_host *host;
1809 DBGF("Suspending...\n");
1811 host = mmc_priv(mmc);
1813 wbsd_chip_poweroff(host);
1817 static int wbsd_platform_resume(struct platform_device *dev)
1819 struct mmc_host *mmc = platform_get_drvdata(dev);
1820 struct wbsd_host *host;
1825 DBGF("Resuming...\n");
1827 host = mmc_priv(mmc);
1829 wbsd_chip_config(host);
1832 * Allow device to initialise itself properly.
1836 wbsd_init_device(host);
1842 static int wbsd_pnp_suspend(struct pnp_dev *pnp_dev, pm_message_t state)
1844 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1849 DBGF("Suspending...\n");
1853 static int wbsd_pnp_resume(struct pnp_dev *pnp_dev)
1855 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1856 struct wbsd_host *host;
1861 DBGF("Resuming...\n");
1863 host = mmc_priv(mmc);
1866 * See if chip needs to be configured.
1868 if (host->config != 0) {
1869 if (!wbsd_chip_validate(host)) {
1870 pr_warn(DRIVER_NAME ": PnP active but chip not configured! You probably have a buggy BIOS. Configuring chip manually.\n");
1871 wbsd_chip_config(host);
1876 * Allow device to initialise itself properly.
1880 wbsd_init_device(host);
1884 #endif /* CONFIG_PNP */
1886 #else /* CONFIG_PM */
1888 #define wbsd_platform_suspend NULL
1889 #define wbsd_platform_resume NULL
1891 #define wbsd_pnp_suspend NULL
1892 #define wbsd_pnp_resume NULL
1894 #endif /* CONFIG_PM */
1896 static struct platform_device *wbsd_device;
1898 static struct platform_driver wbsd_driver = {
1899 .probe = wbsd_probe,
1900 .remove = wbsd_remove,
1902 .suspend = wbsd_platform_suspend,
1903 .resume = wbsd_platform_resume,
1905 .name = DRIVER_NAME,
1911 static struct pnp_driver wbsd_pnp_driver = {
1912 .name = DRIVER_NAME,
1913 .id_table = pnp_dev_table,
1914 .probe = wbsd_pnp_probe,
1915 .remove = wbsd_pnp_remove,
1917 .suspend = wbsd_pnp_suspend,
1918 .resume = wbsd_pnp_resume,
1921 #endif /* CONFIG_PNP */
1924 * Module loading/unloading
1927 static int __init wbsd_drv_init(void)
1932 ": Winbond W83L51xD SD/MMC card interface driver\n");
1933 pr_info(DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1938 result = pnp_register_driver(&wbsd_pnp_driver);
1942 #endif /* CONFIG_PNP */
1945 result = platform_driver_register(&wbsd_driver);
1949 wbsd_device = platform_device_alloc(DRIVER_NAME, -1);
1951 platform_driver_unregister(&wbsd_driver);
1955 result = platform_device_add(wbsd_device);
1957 platform_device_put(wbsd_device);
1958 platform_driver_unregister(&wbsd_driver);
1966 static void __exit wbsd_drv_exit(void)
1971 pnp_unregister_driver(&wbsd_pnp_driver);
1973 #endif /* CONFIG_PNP */
1976 platform_device_unregister(wbsd_device);
1978 platform_driver_unregister(&wbsd_driver);
1984 module_init(wbsd_drv_init);
1985 module_exit(wbsd_drv_exit);
1987 module_param_hw_named(nopnp, param_nopnp, uint, other, 0444);
1989 module_param_hw_named(io, param_io, uint, ioport, 0444);
1990 module_param_hw_named(irq, param_irq, uint, irq, 0444);
1991 module_param_hw_named(dma, param_dma, int, dma, 0444);
1993 MODULE_LICENSE("GPL");
1995 MODULE_DESCRIPTION("Winbond W83L51xD SD/MMC card interface driver");
1998 MODULE_PARM_DESC(nopnp, "Scan for device instead of relying on PNP. (default 0)");
2000 MODULE_PARM_DESC(io, "I/O base to allocate. Must be 8 byte aligned. (default 0x248)");
2001 MODULE_PARM_DESC(irq, "IRQ to allocate. (default 6)");
2002 MODULE_PARM_DESC(dma, "DMA channel to allocate. -1 for no DMA. (default 2)");