2 * linux/drivers/mmc/wbsd.c - Winbond W83L51xD SD/MMC driver
4 * Copyright (C) 2004-2005 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 version 2 as
8 * published by the Free Software Foundation.
13 * Changes to the FIFO system should be done with extreme care since
14 * the hardware is full of bugs related to the FIFO. Known issues are:
16 * - FIFO size field in FSR is always zero.
18 * - FIFO interrupts tend not to work as they should. Interrupts are
19 * triggered only for full/empty events, not for threshold values.
21 * - On APIC systems the FIFO empty interrupt is sometimes lost.
24 #include <linux/config.h>
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/init.h>
28 #include <linux/ioport.h>
29 #include <linux/device.h>
30 #include <linux/interrupt.h>
31 #include <linux/dma-mapping.h>
32 #include <linux/delay.h>
33 #include <linux/pnp.h>
34 #include <linux/highmem.h>
35 #include <linux/mmc/host.h>
36 #include <linux/mmc/protocol.h>
40 #include <asm/scatterlist.h>
44 #define DRIVER_NAME "wbsd"
45 #define DRIVER_VERSION "1.2"
47 #ifdef CONFIG_MMC_DEBUG
49 printk(KERN_DEBUG DRIVER_NAME ": " x)
50 #define DBGF(f, x...) \
51 printk(KERN_DEBUG DRIVER_NAME " [%s()]: " f, __func__ , ##x)
53 #define DBG(x...) do { } while (0)
54 #define DBGF(x...) do { } while (0)
63 static const struct pnp_device_id pnp_dev_table[] = {
69 MODULE_DEVICE_TABLE(pnp, pnp_dev_table);
71 #endif /* CONFIG_PNP */
73 static const int config_ports[] = { 0x2E, 0x4E };
74 static const int unlock_codes[] = { 0x83, 0x87 };
76 static const int valid_ids[] = {
81 static unsigned int nopnp = 0;
83 static const unsigned int nopnp = 1;
85 static unsigned int io = 0x248;
86 static unsigned int irq = 6;
93 static inline void wbsd_unlock_config(struct wbsd_host* host)
95 BUG_ON(host->config == 0);
97 outb(host->unlock_code, host->config);
98 outb(host->unlock_code, host->config);
101 static inline void wbsd_lock_config(struct wbsd_host* host)
103 BUG_ON(host->config == 0);
105 outb(LOCK_CODE, host->config);
108 static inline void wbsd_write_config(struct wbsd_host* host, u8 reg, u8 value)
110 BUG_ON(host->config == 0);
112 outb(reg, host->config);
113 outb(value, host->config + 1);
116 static inline u8 wbsd_read_config(struct wbsd_host* host, u8 reg)
118 BUG_ON(host->config == 0);
120 outb(reg, host->config);
121 return inb(host->config + 1);
124 static inline void wbsd_write_index(struct wbsd_host* host, u8 index, u8 value)
126 outb(index, host->base + WBSD_IDXR);
127 outb(value, host->base + WBSD_DATAR);
130 static inline u8 wbsd_read_index(struct wbsd_host* host, u8 index)
132 outb(index, host->base + WBSD_IDXR);
133 return inb(host->base + WBSD_DATAR);
140 static void wbsd_init_device(struct wbsd_host* host)
145 * Reset chip (SD/MMC part) and fifo.
147 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
148 setup |= WBSD_FIFO_RESET | WBSD_SOFT_RESET;
149 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
154 setup &= ~WBSD_DAT3_H;
155 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
156 host->flags &= ~WBSD_FIGNORE_DETECT;
159 * Read back default clock.
161 host->clk = wbsd_read_index(host, WBSD_IDX_CLK);
166 outb(WBSD_POWER_N, host->base + WBSD_CSR);
169 * Set maximum timeout.
171 wbsd_write_index(host, WBSD_IDX_TAAC, 0x7F);
174 * Test for card presence
176 if (inb(host->base + WBSD_CSR) & WBSD_CARDPRESENT)
177 host->flags |= WBSD_FCARD_PRESENT;
179 host->flags &= ~WBSD_FCARD_PRESENT;
182 * Enable interesting interrupts.
185 ier |= WBSD_EINT_CARD;
186 ier |= WBSD_EINT_FIFO_THRE;
187 ier |= WBSD_EINT_CCRC;
188 ier |= WBSD_EINT_TIMEOUT;
189 ier |= WBSD_EINT_CRC;
192 outb(ier, host->base + WBSD_EIR);
197 inb(host->base + WBSD_ISR);
200 static void wbsd_reset(struct wbsd_host* host)
204 printk(KERN_ERR DRIVER_NAME ": Resetting chip\n");
207 * Soft reset of chip (SD/MMC part).
209 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
210 setup |= WBSD_SOFT_RESET;
211 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
214 static void wbsd_request_end(struct wbsd_host* host, struct mmc_request* mrq)
216 unsigned long dmaflags;
218 DBGF("Ending request, cmd (%x)\n", mrq->cmd->opcode);
223 * Release ISA DMA controller.
225 dmaflags = claim_dma_lock();
226 disable_dma(host->dma);
227 clear_dma_ff(host->dma);
228 release_dma_lock(dmaflags);
231 * Disable DMA on host.
233 wbsd_write_index(host, WBSD_IDX_DMA, 0);
239 * MMC layer might call back into the driver so first unlock.
241 spin_unlock(&host->lock);
242 mmc_request_done(host->mmc, mrq);
243 spin_lock(&host->lock);
247 * Scatter/gather functions
250 static inline void wbsd_init_sg(struct wbsd_host* host, struct mmc_data* data)
253 * Get info. about SG list from data structure.
255 host->cur_sg = data->sg;
256 host->num_sg = data->sg_len;
259 host->remain = host->cur_sg->length;
262 static inline int wbsd_next_sg(struct wbsd_host* host)
265 * Skip to next SG entry.
273 if (host->num_sg > 0)
276 host->remain = host->cur_sg->length;
282 static inline char* wbsd_kmap_sg(struct wbsd_host* host)
284 host->mapped_sg = kmap_atomic(host->cur_sg->page, KM_BIO_SRC_IRQ) +
285 host->cur_sg->offset;
286 return host->mapped_sg;
289 static inline void wbsd_kunmap_sg(struct wbsd_host* host)
291 kunmap_atomic(host->mapped_sg, KM_BIO_SRC_IRQ);
294 static inline void wbsd_sg_to_dma(struct wbsd_host* host, struct mmc_data* data)
296 unsigned int len, i, size;
297 struct scatterlist* sg;
298 char* dmabuf = host->dma_buffer;
307 * Just loop through all entries. Size might not
308 * be the entire list though so make sure that
309 * we do not transfer too much.
311 for (i = 0;i < len;i++)
313 sgbuf = kmap_atomic(sg[i].page, KM_BIO_SRC_IRQ) + sg[i].offset;
314 if (size < sg[i].length)
315 memcpy(dmabuf, sgbuf, size);
317 memcpy(dmabuf, sgbuf, sg[i].length);
318 kunmap_atomic(sgbuf, KM_BIO_SRC_IRQ);
319 dmabuf += sg[i].length;
321 if (size < sg[i].length)
324 size -= sg[i].length;
331 * Check that we didn't get a request to transfer
332 * more data than can fit into the SG list.
340 static inline void wbsd_dma_to_sg(struct wbsd_host* host, struct mmc_data* data)
342 unsigned int len, i, size;
343 struct scatterlist* sg;
344 char* dmabuf = host->dma_buffer;
353 * Just loop through all entries. Size might not
354 * be the entire list though so make sure that
355 * we do not transfer too much.
357 for (i = 0;i < len;i++)
359 sgbuf = kmap_atomic(sg[i].page, KM_BIO_SRC_IRQ) + sg[i].offset;
360 if (size < sg[i].length)
361 memcpy(sgbuf, dmabuf, size);
363 memcpy(sgbuf, dmabuf, sg[i].length);
364 kunmap_atomic(sgbuf, KM_BIO_SRC_IRQ);
365 dmabuf += sg[i].length;
367 if (size < sg[i].length)
370 size -= sg[i].length;
377 * Check that we didn't get a request to transfer
378 * more data than can fit into the SG list.
390 static inline void wbsd_get_short_reply(struct wbsd_host* host,
391 struct mmc_command* cmd)
394 * Correct response type?
396 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_SHORT)
398 cmd->error = MMC_ERR_INVALID;
403 wbsd_read_index(host, WBSD_IDX_RESP12) << 24;
405 wbsd_read_index(host, WBSD_IDX_RESP13) << 16;
407 wbsd_read_index(host, WBSD_IDX_RESP14) << 8;
409 wbsd_read_index(host, WBSD_IDX_RESP15) << 0;
411 wbsd_read_index(host, WBSD_IDX_RESP16) << 24;
414 static inline void wbsd_get_long_reply(struct wbsd_host* host,
415 struct mmc_command* cmd)
420 * Correct response type?
422 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_LONG)
424 cmd->error = MMC_ERR_INVALID;
428 for (i = 0;i < 4;i++)
431 wbsd_read_index(host, WBSD_IDX_RESP1 + i * 4) << 24;
433 wbsd_read_index(host, WBSD_IDX_RESP2 + i * 4) << 16;
435 wbsd_read_index(host, WBSD_IDX_RESP3 + i * 4) << 8;
437 wbsd_read_index(host, WBSD_IDX_RESP4 + i * 4) << 0;
441 static void wbsd_send_command(struct wbsd_host* host, struct mmc_command* cmd)
446 DBGF("Sending cmd (%x)\n", cmd->opcode);
449 * Clear accumulated ISR. The interrupt routine
450 * will fill this one with events that occur during
456 * Send the command (CRC calculated by host).
458 outb(cmd->opcode, host->base + WBSD_CMDR);
459 for (i = 3;i >= 0;i--)
460 outb((cmd->arg >> (i * 8)) & 0xff, host->base + WBSD_CMDR);
462 cmd->error = MMC_ERR_NONE;
465 * Wait for the request to complete.
468 status = wbsd_read_index(host, WBSD_IDX_STATUS);
469 } while (status & WBSD_CARDTRAFFIC);
472 * Do we expect a reply?
474 if ((cmd->flags & MMC_RSP_MASK) != MMC_RSP_NONE)
482 if (isr & WBSD_INT_CARD)
483 cmd->error = MMC_ERR_TIMEOUT;
485 else if (isr & WBSD_INT_TIMEOUT)
486 cmd->error = MMC_ERR_TIMEOUT;
488 else if ((cmd->flags & MMC_RSP_CRC) && (isr & WBSD_INT_CRC))
489 cmd->error = MMC_ERR_BADCRC;
493 if ((cmd->flags & MMC_RSP_MASK) == MMC_RSP_SHORT)
494 wbsd_get_short_reply(host, cmd);
496 wbsd_get_long_reply(host, cmd);
500 DBGF("Sent cmd (%x), res %d\n", cmd->opcode, cmd->error);
507 static void wbsd_empty_fifo(struct wbsd_host* host)
509 struct mmc_data* data = host->mrq->cmd->data;
514 * Handle excessive data.
516 if (data->bytes_xfered == host->size)
519 buffer = wbsd_kmap_sg(host) + host->offset;
522 * Drain the fifo. This has a tendency to loop longer
523 * than the FIFO length (usually one block).
525 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_EMPTY))
528 * The size field in the FSR is broken so we have to
531 if (fsr & WBSD_FIFO_FULL)
533 else if (fsr & WBSD_FIFO_FUTHRE)
538 for (i = 0;i < fifo;i++)
540 *buffer = inb(host->base + WBSD_DFR);
545 data->bytes_xfered++;
550 if (data->bytes_xfered == host->size)
552 wbsd_kunmap_sg(host);
557 * End of scatter list entry?
559 if (host->remain == 0)
561 wbsd_kunmap_sg(host);
564 * Get next entry. Check if last.
566 if (!wbsd_next_sg(host))
569 * We should never reach this point.
570 * It means that we're trying to
571 * transfer more blocks than can fit
572 * into the scatter list.
576 host->size = data->bytes_xfered;
581 buffer = wbsd_kmap_sg(host);
586 wbsd_kunmap_sg(host);
589 * This is a very dirty hack to solve a
590 * hardware problem. The chip doesn't trigger
591 * FIFO threshold interrupts properly.
593 if ((host->size - data->bytes_xfered) < 16)
594 tasklet_schedule(&host->fifo_tasklet);
597 static void wbsd_fill_fifo(struct wbsd_host* host)
599 struct mmc_data* data = host->mrq->cmd->data;
604 * Check that we aren't being called after the
605 * entire buffer has been transfered.
607 if (data->bytes_xfered == host->size)
610 buffer = wbsd_kmap_sg(host) + host->offset;
613 * Fill the fifo. This has a tendency to loop longer
614 * than the FIFO length (usually one block).
616 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_FULL))
619 * The size field in the FSR is broken so we have to
622 if (fsr & WBSD_FIFO_EMPTY)
624 else if (fsr & WBSD_FIFO_EMTHRE)
629 for (i = 16;i > fifo;i--)
631 outb(*buffer, host->base + WBSD_DFR);
636 data->bytes_xfered++;
641 if (data->bytes_xfered == host->size)
643 wbsd_kunmap_sg(host);
648 * End of scatter list entry?
650 if (host->remain == 0)
652 wbsd_kunmap_sg(host);
655 * Get next entry. Check if last.
657 if (!wbsd_next_sg(host))
660 * We should never reach this point.
661 * It means that we're trying to
662 * transfer more blocks than can fit
663 * into the scatter list.
667 host->size = data->bytes_xfered;
672 buffer = wbsd_kmap_sg(host);
677 wbsd_kunmap_sg(host);
680 * The controller stops sending interrupts for
681 * 'FIFO empty' under certain conditions. So we
682 * need to be a bit more pro-active.
684 tasklet_schedule(&host->fifo_tasklet);
687 static void wbsd_prepare_data(struct wbsd_host* host, struct mmc_data* data)
691 unsigned long dmaflags;
693 DBGF("blksz %04x blks %04x flags %08x\n",
694 1 << data->blksz_bits, data->blocks, data->flags);
695 DBGF("tsac %d ms nsac %d clk\n",
696 data->timeout_ns / 1000000, data->timeout_clks);
701 host->size = data->blocks << data->blksz_bits;
704 * Check timeout values for overflow.
705 * (Yes, some cards cause this value to overflow).
707 if (data->timeout_ns > 127000000)
708 wbsd_write_index(host, WBSD_IDX_TAAC, 127);
710 wbsd_write_index(host, WBSD_IDX_TAAC, data->timeout_ns/1000000);
712 if (data->timeout_clks > 255)
713 wbsd_write_index(host, WBSD_IDX_NSAC, 255);
715 wbsd_write_index(host, WBSD_IDX_NSAC, data->timeout_clks);
718 * Inform the chip of how large blocks will be
719 * sent. It needs this to determine when to
722 * Space for CRC must be included in the size.
724 blksize = (1 << data->blksz_bits) + 2;
726 wbsd_write_index(host, WBSD_IDX_PBSMSB, (blksize >> 4) & 0xF0);
727 wbsd_write_index(host, WBSD_IDX_PBSLSB, blksize & 0xFF);
730 * Clear the FIFO. This is needed even for DMA
731 * transfers since the chip still uses the FIFO
734 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
735 setup |= WBSD_FIFO_RESET;
736 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
744 * The buffer for DMA is only 64 kB.
746 BUG_ON(host->size > 0x10000);
747 if (host->size > 0x10000)
749 data->error = MMC_ERR_INVALID;
754 * Transfer data from the SG list to
757 if (data->flags & MMC_DATA_WRITE)
758 wbsd_sg_to_dma(host, data);
761 * Initialise the ISA DMA controller.
763 dmaflags = claim_dma_lock();
764 disable_dma(host->dma);
765 clear_dma_ff(host->dma);
766 if (data->flags & MMC_DATA_READ)
767 set_dma_mode(host->dma, DMA_MODE_READ & ~0x40);
769 set_dma_mode(host->dma, DMA_MODE_WRITE & ~0x40);
770 set_dma_addr(host->dma, host->dma_addr);
771 set_dma_count(host->dma, host->size);
773 enable_dma(host->dma);
774 release_dma_lock(dmaflags);
777 * Enable DMA on the host.
779 wbsd_write_index(host, WBSD_IDX_DMA, WBSD_DMA_ENABLE);
784 * This flag is used to keep printk
785 * output to a minimum.
790 * Initialise the SG list.
792 wbsd_init_sg(host, data);
797 wbsd_write_index(host, WBSD_IDX_DMA, 0);
800 * Set up FIFO threshold levels (and fill
801 * buffer if doing a write).
803 if (data->flags & MMC_DATA_READ)
805 wbsd_write_index(host, WBSD_IDX_FIFOEN,
806 WBSD_FIFOEN_FULL | 8);
810 wbsd_write_index(host, WBSD_IDX_FIFOEN,
811 WBSD_FIFOEN_EMPTY | 8);
812 wbsd_fill_fifo(host);
816 data->error = MMC_ERR_NONE;
819 static void wbsd_finish_data(struct wbsd_host* host, struct mmc_data* data)
821 unsigned long dmaflags;
825 WARN_ON(host->mrq == NULL);
828 * Send a stop command if needed.
831 wbsd_send_command(host, data->stop);
834 * Wait for the controller to leave data
839 status = wbsd_read_index(host, WBSD_IDX_STATUS);
840 } while (status & (WBSD_BLOCK_READ | WBSD_BLOCK_WRITE));
848 * Disable DMA on the host.
850 wbsd_write_index(host, WBSD_IDX_DMA, 0);
853 * Turn of ISA DMA controller.
855 dmaflags = claim_dma_lock();
856 disable_dma(host->dma);
857 clear_dma_ff(host->dma);
858 count = get_dma_residue(host->dma);
859 release_dma_lock(dmaflags);
866 printk(KERN_ERR DRIVER_NAME ": Incomplete DMA "
867 "transfer. %d bytes left.\n", count);
869 data->error = MMC_ERR_FAILED;
874 * Transfer data from DMA buffer to
877 if (data->flags & MMC_DATA_READ)
878 wbsd_dma_to_sg(host, data);
880 data->bytes_xfered = host->size;
884 DBGF("Ending data transfer (%d bytes)\n", data->bytes_xfered);
886 wbsd_request_end(host, host->mrq);
889 /*****************************************************************************\
891 * MMC layer callbacks *
893 \*****************************************************************************/
895 static void wbsd_request(struct mmc_host* mmc, struct mmc_request* mrq)
897 struct wbsd_host* host = mmc_priv(mmc);
898 struct mmc_command* cmd;
901 * Disable tasklets to avoid a deadlock.
903 spin_lock_bh(&host->lock);
905 BUG_ON(host->mrq != NULL);
912 * If there is no card in the slot then
913 * timeout immediatly.
915 if (!(host->flags & WBSD_FCARD_PRESENT))
917 cmd->error = MMC_ERR_TIMEOUT;
922 * Does the request include data?
926 wbsd_prepare_data(host, cmd->data);
928 if (cmd->data->error != MMC_ERR_NONE)
932 wbsd_send_command(host, cmd);
935 * If this is a data transfer the request
936 * will be finished after the data has
939 if (cmd->data && (cmd->error == MMC_ERR_NONE))
942 * Dirty fix for hardware bug.
945 tasklet_schedule(&host->fifo_tasklet);
947 spin_unlock_bh(&host->lock);
953 wbsd_request_end(host, mrq);
955 spin_unlock_bh(&host->lock);
958 static void wbsd_set_ios(struct mmc_host* mmc, struct mmc_ios* ios)
960 struct wbsd_host* host = mmc_priv(mmc);
963 DBGF("clock %uHz busmode %u powermode %u Vdd %u\n",
964 ios->clock, ios->bus_mode, ios->power_mode, ios->vdd);
966 spin_lock_bh(&host->lock);
969 * Reset the chip on each power off.
970 * Should clear out any weird states.
972 if (ios->power_mode == MMC_POWER_OFF)
973 wbsd_init_device(host);
975 if (ios->clock >= 24000000)
977 else if (ios->clock >= 16000000)
979 else if (ios->clock >= 12000000)
985 * Only write to the clock register when
986 * there is an actual change.
988 if (clk != host->clk)
990 wbsd_write_index(host, WBSD_IDX_CLK, clk);
997 if (ios->power_mode != MMC_POWER_OFF)
999 pwr = inb(host->base + WBSD_CSR);
1000 pwr &= ~WBSD_POWER_N;
1001 outb(pwr, host->base + WBSD_CSR);
1005 * MMC cards need to have pin 1 high during init.
1006 * Init time corresponds rather nicely with the bus mode.
1007 * It wreaks havoc with the card detection though so
1008 * that needs to be disabed.
1010 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
1011 if ((ios->power_mode == MMC_POWER_ON) &&
1012 (ios->bus_mode == MMC_BUSMODE_OPENDRAIN))
1014 setup |= WBSD_DAT3_H;
1015 host->flags |= WBSD_FIGNORE_DETECT;
1019 setup &= ~WBSD_DAT3_H;
1020 host->flags &= ~WBSD_FIGNORE_DETECT;
1022 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
1024 spin_unlock_bh(&host->lock);
1027 static struct mmc_host_ops wbsd_ops = {
1028 .request = wbsd_request,
1029 .set_ios = wbsd_set_ios,
1032 /*****************************************************************************\
1034 * Interrupt handling *
1036 \*****************************************************************************/
1039 * Helper function for card detection
1041 static void wbsd_detect_card(unsigned long data)
1043 struct wbsd_host *host = (struct wbsd_host*)data;
1045 BUG_ON(host == NULL);
1047 DBG("Executing card detection\n");
1049 mmc_detect_change(host->mmc);
1056 static inline struct mmc_data* wbsd_get_data(struct wbsd_host* host)
1058 WARN_ON(!host->mrq);
1062 WARN_ON(!host->mrq->cmd);
1063 if (!host->mrq->cmd)
1066 WARN_ON(!host->mrq->cmd->data);
1067 if (!host->mrq->cmd->data)
1070 return host->mrq->cmd->data;
1073 static void wbsd_tasklet_card(unsigned long param)
1075 struct wbsd_host* host = (struct wbsd_host*)param;
1078 spin_lock(&host->lock);
1080 if (host->flags & WBSD_FIGNORE_DETECT)
1082 spin_unlock(&host->lock);
1086 csr = inb(host->base + WBSD_CSR);
1087 WARN_ON(csr == 0xff);
1089 if (csr & WBSD_CARDPRESENT)
1091 if (!(host->flags & WBSD_FCARD_PRESENT))
1093 DBG("Card inserted\n");
1094 host->flags |= WBSD_FCARD_PRESENT;
1097 * Delay card detection to allow electrical connections
1100 mod_timer(&host->timer, jiffies + HZ/2);
1103 spin_unlock(&host->lock);
1105 else if (host->flags & WBSD_FCARD_PRESENT)
1107 DBG("Card removed\n");
1108 host->flags &= ~WBSD_FCARD_PRESENT;
1112 printk(KERN_ERR DRIVER_NAME
1113 ": Card removed during transfer!\n");
1116 host->mrq->cmd->error = MMC_ERR_FAILED;
1117 tasklet_schedule(&host->finish_tasklet);
1121 * Unlock first since we might get a call back.
1123 spin_unlock(&host->lock);
1125 mmc_detect_change(host->mmc);
1129 static void wbsd_tasklet_fifo(unsigned long param)
1131 struct wbsd_host* host = (struct wbsd_host*)param;
1132 struct mmc_data* data;
1134 spin_lock(&host->lock);
1139 data = wbsd_get_data(host);
1143 if (data->flags & MMC_DATA_WRITE)
1144 wbsd_fill_fifo(host);
1146 wbsd_empty_fifo(host);
1151 if (host->size == data->bytes_xfered)
1153 wbsd_write_index(host, WBSD_IDX_FIFOEN, 0);
1154 tasklet_schedule(&host->finish_tasklet);
1158 spin_unlock(&host->lock);
1161 static void wbsd_tasklet_crc(unsigned long param)
1163 struct wbsd_host* host = (struct wbsd_host*)param;
1164 struct mmc_data* data;
1166 spin_lock(&host->lock);
1171 data = wbsd_get_data(host);
1175 DBGF("CRC error\n");
1177 data->error = MMC_ERR_BADCRC;
1179 tasklet_schedule(&host->finish_tasklet);
1182 spin_unlock(&host->lock);
1185 static void wbsd_tasklet_timeout(unsigned long param)
1187 struct wbsd_host* host = (struct wbsd_host*)param;
1188 struct mmc_data* data;
1190 spin_lock(&host->lock);
1195 data = wbsd_get_data(host);
1201 data->error = MMC_ERR_TIMEOUT;
1203 tasklet_schedule(&host->finish_tasklet);
1206 spin_unlock(&host->lock);
1209 static void wbsd_tasklet_finish(unsigned long param)
1211 struct wbsd_host* host = (struct wbsd_host*)param;
1212 struct mmc_data* data;
1214 spin_lock(&host->lock);
1216 WARN_ON(!host->mrq);
1220 data = wbsd_get_data(host);
1224 wbsd_finish_data(host, data);
1227 spin_unlock(&host->lock);
1230 static void wbsd_tasklet_block(unsigned long param)
1232 struct wbsd_host* host = (struct wbsd_host*)param;
1233 struct mmc_data* data;
1235 spin_lock(&host->lock);
1237 if ((wbsd_read_index(host, WBSD_IDX_CRCSTATUS) & WBSD_CRC_MASK) !=
1240 data = wbsd_get_data(host);
1244 DBGF("CRC error\n");
1246 data->error = MMC_ERR_BADCRC;
1248 tasklet_schedule(&host->finish_tasklet);
1252 spin_unlock(&host->lock);
1256 * Interrupt handling
1259 static irqreturn_t wbsd_irq(int irq, void *dev_id, struct pt_regs *regs)
1261 struct wbsd_host* host = dev_id;
1264 isr = inb(host->base + WBSD_ISR);
1267 * Was it actually our hardware that caused the interrupt?
1269 if (isr == 0xff || isr == 0x00)
1275 * Schedule tasklets as needed.
1277 if (isr & WBSD_INT_CARD)
1278 tasklet_schedule(&host->card_tasklet);
1279 if (isr & WBSD_INT_FIFO_THRE)
1280 tasklet_schedule(&host->fifo_tasklet);
1281 if (isr & WBSD_INT_CRC)
1282 tasklet_hi_schedule(&host->crc_tasklet);
1283 if (isr & WBSD_INT_TIMEOUT)
1284 tasklet_hi_schedule(&host->timeout_tasklet);
1285 if (isr & WBSD_INT_BUSYEND)
1286 tasklet_hi_schedule(&host->block_tasklet);
1287 if (isr & WBSD_INT_TC)
1288 tasklet_schedule(&host->finish_tasklet);
1293 /*****************************************************************************\
1295 * Device initialisation and shutdown *
1297 \*****************************************************************************/
1300 * Allocate/free MMC structure.
1303 static int __devinit wbsd_alloc_mmc(struct device* dev)
1305 struct mmc_host* mmc;
1306 struct wbsd_host* host;
1309 * Allocate MMC structure.
1311 mmc = mmc_alloc_host(sizeof(struct wbsd_host), dev);
1315 host = mmc_priv(mmc);
1321 * Set host parameters.
1323 mmc->ops = &wbsd_ops;
1324 mmc->f_min = 375000;
1325 mmc->f_max = 24000000;
1326 mmc->ocr_avail = MMC_VDD_32_33|MMC_VDD_33_34;
1328 spin_lock_init(&host->lock);
1331 * Set up detection timer
1333 init_timer(&host->timer);
1334 host->timer.data = (unsigned long)host;
1335 host->timer.function = wbsd_detect_card;
1338 * Maximum number of segments. Worst case is one sector per segment
1339 * so this will be 64kB/512.
1341 mmc->max_hw_segs = 128;
1342 mmc->max_phys_segs = 128;
1345 * Maximum number of sectors in one transfer. Also limited by 64kB
1348 mmc->max_sectors = 128;
1351 * Maximum segment size. Could be one segment with the maximum number
1354 mmc->max_seg_size = mmc->max_sectors * 512;
1356 dev_set_drvdata(dev, mmc);
1361 static void __devexit wbsd_free_mmc(struct device* dev)
1363 struct mmc_host* mmc;
1364 struct wbsd_host* host;
1366 mmc = dev_get_drvdata(dev);
1370 host = mmc_priv(mmc);
1371 BUG_ON(host == NULL);
1373 del_timer_sync(&host->timer);
1377 dev_set_drvdata(dev, NULL);
1381 * Scan for known chip id:s
1384 static int __devinit wbsd_scan(struct wbsd_host* host)
1390 * Iterate through all ports, all codes to
1391 * find hardware that is in our known list.
1393 for (i = 0;i < sizeof(config_ports)/sizeof(int);i++)
1395 if (!request_region(config_ports[i], 2, DRIVER_NAME))
1398 for (j = 0;j < sizeof(unlock_codes)/sizeof(int);j++)
1402 outb(unlock_codes[j], config_ports[i]);
1403 outb(unlock_codes[j], config_ports[i]);
1405 outb(WBSD_CONF_ID_HI, config_ports[i]);
1406 id = inb(config_ports[i] + 1) << 8;
1408 outb(WBSD_CONF_ID_LO, config_ports[i]);
1409 id |= inb(config_ports[i] + 1);
1411 for (k = 0;k < sizeof(valid_ids)/sizeof(int);k++)
1413 if (id == valid_ids[k])
1416 host->config = config_ports[i];
1417 host->unlock_code = unlock_codes[i];
1425 DBG("Unknown hardware (id %x) found at %x\n",
1426 id, config_ports[i]);
1429 outb(LOCK_CODE, config_ports[i]);
1432 release_region(config_ports[i], 2);
1439 * Allocate/free io port ranges
1442 static int __devinit wbsd_request_region(struct wbsd_host* host, int base)
1447 if (!request_region(base, 8, DRIVER_NAME))
1455 static void __devexit wbsd_release_regions(struct wbsd_host* host)
1458 release_region(host->base, 8);
1463 release_region(host->config, 2);
1469 * Allocate/free DMA port and buffer
1472 static void __devinit wbsd_request_dma(struct wbsd_host* host, int dma)
1477 if (request_dma(dma, DRIVER_NAME))
1481 * We need to allocate a special buffer in
1482 * order for ISA to be able to DMA to it.
1484 host->dma_buffer = kmalloc(WBSD_DMA_SIZE,
1485 GFP_NOIO | GFP_DMA | __GFP_REPEAT | __GFP_NOWARN);
1486 if (!host->dma_buffer)
1490 * Translate the address to a physical address.
1492 host->dma_addr = dma_map_single(host->mmc->dev, host->dma_buffer,
1493 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1496 * ISA DMA must be aligned on a 64k basis.
1498 if ((host->dma_addr & 0xffff) != 0)
1501 * ISA cannot access memory above 16 MB.
1503 else if (host->dma_addr >= 0x1000000)
1512 * If we've gotten here then there is some kind of alignment bug
1516 dma_unmap_single(host->mmc->dev, host->dma_addr, WBSD_DMA_SIZE,
1518 host->dma_addr = (dma_addr_t)NULL;
1520 kfree(host->dma_buffer);
1521 host->dma_buffer = NULL;
1527 printk(KERN_WARNING DRIVER_NAME ": Unable to allocate DMA %d. "
1528 "Falling back on FIFO.\n", dma);
1531 static void __devexit wbsd_release_dma(struct wbsd_host* host)
1534 dma_unmap_single(host->mmc->dev, host->dma_addr, WBSD_DMA_SIZE,
1536 if (host->dma_buffer)
1537 kfree(host->dma_buffer);
1539 free_dma(host->dma);
1542 host->dma_buffer = NULL;
1543 host->dma_addr = (dma_addr_t)NULL;
1547 * Allocate/free IRQ.
1550 static int __devinit wbsd_request_irq(struct wbsd_host* host, int irq)
1555 * Allocate interrupt.
1558 ret = request_irq(irq, wbsd_irq, SA_SHIRQ, DRIVER_NAME, host);
1567 tasklet_init(&host->card_tasklet, wbsd_tasklet_card, (unsigned long)host);
1568 tasklet_init(&host->fifo_tasklet, wbsd_tasklet_fifo, (unsigned long)host);
1569 tasklet_init(&host->crc_tasklet, wbsd_tasklet_crc, (unsigned long)host);
1570 tasklet_init(&host->timeout_tasklet, wbsd_tasklet_timeout, (unsigned long)host);
1571 tasklet_init(&host->finish_tasklet, wbsd_tasklet_finish, (unsigned long)host);
1572 tasklet_init(&host->block_tasklet, wbsd_tasklet_block, (unsigned long)host);
1577 static void __devexit wbsd_release_irq(struct wbsd_host* host)
1582 free_irq(host->irq, host);
1586 tasklet_kill(&host->card_tasklet);
1587 tasklet_kill(&host->fifo_tasklet);
1588 tasklet_kill(&host->crc_tasklet);
1589 tasklet_kill(&host->timeout_tasklet);
1590 tasklet_kill(&host->finish_tasklet);
1591 tasklet_kill(&host->block_tasklet);
1595 * Allocate all resources for the host.
1598 static int __devinit wbsd_request_resources(struct wbsd_host* host,
1599 int base, int irq, int dma)
1604 * Allocate I/O ports.
1606 ret = wbsd_request_region(host, base);
1611 * Allocate interrupt.
1613 ret = wbsd_request_irq(host, irq);
1620 wbsd_request_dma(host, dma);
1626 * Release all resources for the host.
1629 static void __devexit wbsd_release_resources(struct wbsd_host* host)
1631 wbsd_release_dma(host);
1632 wbsd_release_irq(host);
1633 wbsd_release_regions(host);
1637 * Configure the resources the chip should use.
1640 static void __devinit wbsd_chip_config(struct wbsd_host* host)
1645 wbsd_write_config(host, WBSD_CONF_SWRST, 1);
1646 wbsd_write_config(host, WBSD_CONF_SWRST, 0);
1649 * Select SD/MMC function.
1651 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1654 * Set up card detection.
1656 wbsd_write_config(host, WBSD_CONF_PINS, WBSD_PINS_DETECT_GP11);
1661 wbsd_write_config(host, WBSD_CONF_PORT_HI, host->base >> 8);
1662 wbsd_write_config(host, WBSD_CONF_PORT_LO, host->base & 0xff);
1664 wbsd_write_config(host, WBSD_CONF_IRQ, host->irq);
1667 wbsd_write_config(host, WBSD_CONF_DRQ, host->dma);
1670 * Enable and power up chip.
1672 wbsd_write_config(host, WBSD_CONF_ENABLE, 1);
1673 wbsd_write_config(host, WBSD_CONF_POWER, 0x20);
1677 * Check that configured resources are correct.
1680 static int __devinit wbsd_chip_validate(struct wbsd_host* host)
1685 * Select SD/MMC function.
1687 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1690 * Read configuration.
1692 base = wbsd_read_config(host, WBSD_CONF_PORT_HI) << 8;
1693 base |= wbsd_read_config(host, WBSD_CONF_PORT_LO);
1695 irq = wbsd_read_config(host, WBSD_CONF_IRQ);
1697 dma = wbsd_read_config(host, WBSD_CONF_DRQ);
1700 * Validate against given configuration.
1702 if (base != host->base)
1704 if (irq != host->irq)
1706 if ((dma != host->dma) && (host->dma != -1))
1712 /*****************************************************************************\
1714 * Devices setup and shutdown *
1716 \*****************************************************************************/
1718 static int __devinit wbsd_init(struct device* dev, int base, int irq, int dma,
1721 struct wbsd_host* host = NULL;
1722 struct mmc_host* mmc = NULL;
1725 ret = wbsd_alloc_mmc(dev);
1729 mmc = dev_get_drvdata(dev);
1730 host = mmc_priv(mmc);
1733 * Scan for hardware.
1735 ret = wbsd_scan(host);
1738 if (pnp && (ret == -ENODEV))
1740 printk(KERN_WARNING DRIVER_NAME
1741 ": Unable to confirm device presence. You may "
1742 "experience lock-ups.\n");
1752 * Request resources.
1754 ret = wbsd_request_resources(host, io, irq, dma);
1757 wbsd_release_resources(host);
1763 * See if chip needs to be configured.
1765 if (pnp && (host->config != 0))
1767 if (!wbsd_chip_validate(host))
1769 printk(KERN_WARNING DRIVER_NAME
1770 ": PnP active but chip not configured! "
1771 "You probably have a buggy BIOS. "
1772 "Configuring chip manually.\n");
1773 wbsd_chip_config(host);
1777 wbsd_chip_config(host);
1780 * Power Management stuff. No idea how this works.
1785 wbsd_write_config(host, WBSD_CONF_PME, 0xA0);
1788 * Allow device to initialise itself properly.
1793 * Reset the chip into a known state.
1795 wbsd_init_device(host);
1799 printk(KERN_INFO "%s: W83L51xD", mmc->host_name);
1800 if (host->chip_id != 0)
1801 printk(" id %x", (int)host->chip_id);
1802 printk(" at 0x%x irq %d", (int)host->base, (int)host->irq);
1804 printk(" dma %d", (int)host->dma);
1814 static void __devexit wbsd_shutdown(struct device* dev, int pnp)
1816 struct mmc_host* mmc = dev_get_drvdata(dev);
1817 struct wbsd_host* host;
1822 host = mmc_priv(mmc);
1824 mmc_remove_host(mmc);
1829 * Power down the SD/MMC function.
1831 wbsd_unlock_config(host);
1832 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1833 wbsd_write_config(host, WBSD_CONF_ENABLE, 0);
1834 wbsd_lock_config(host);
1837 wbsd_release_resources(host);
1846 static int __devinit wbsd_probe(struct device* dev)
1848 return wbsd_init(dev, io, irq, dma, 0);
1851 static int __devexit wbsd_remove(struct device* dev)
1853 wbsd_shutdown(dev, 0);
1864 static int __devinit
1865 wbsd_pnp_probe(struct pnp_dev * pnpdev, const struct pnp_device_id *dev_id)
1870 * Get resources from PnP layer.
1872 io = pnp_port_start(pnpdev, 0);
1873 irq = pnp_irq(pnpdev, 0);
1874 if (pnp_dma_valid(pnpdev, 0))
1875 dma = pnp_dma(pnpdev, 0);
1879 DBGF("PnP resources: port %3x irq %d dma %d\n", io, irq, dma);
1881 return wbsd_init(&pnpdev->dev, io, irq, dma, 1);
1884 static void __devexit wbsd_pnp_remove(struct pnp_dev * dev)
1886 wbsd_shutdown(&dev->dev, 1);
1889 #endif /* CONFIG_PNP */
1896 static int wbsd_suspend(struct device *dev, pm_message_t state, u32 level)
1898 DBGF("Not yet supported\n");
1903 static int wbsd_resume(struct device *dev, u32 level)
1905 DBGF("Not yet supported\n");
1910 #define wbsd_suspend NULL
1911 #define wbsd_resume NULL
1914 static struct platform_device *wbsd_device;
1916 static struct device_driver wbsd_driver = {
1917 .name = DRIVER_NAME,
1918 .bus = &platform_bus_type,
1919 .probe = wbsd_probe,
1920 .remove = wbsd_remove,
1922 .suspend = wbsd_suspend,
1923 .resume = wbsd_resume,
1928 static struct pnp_driver wbsd_pnp_driver = {
1929 .name = DRIVER_NAME,
1930 .id_table = pnp_dev_table,
1931 .probe = wbsd_pnp_probe,
1932 .remove = wbsd_pnp_remove,
1935 #endif /* CONFIG_PNP */
1938 * Module loading/unloading
1941 static int __init wbsd_drv_init(void)
1945 printk(KERN_INFO DRIVER_NAME
1946 ": Winbond W83L51xD SD/MMC card interface driver, "
1947 DRIVER_VERSION "\n");
1948 printk(KERN_INFO DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1954 result = pnp_register_driver(&wbsd_pnp_driver);
1959 #endif /* CONFIG_PNP */
1963 result = driver_register(&wbsd_driver);
1967 wbsd_device = platform_device_register_simple(DRIVER_NAME, -1,
1969 if (IS_ERR(wbsd_device))
1970 return PTR_ERR(wbsd_device);
1976 static void __exit wbsd_drv_exit(void)
1981 pnp_unregister_driver(&wbsd_pnp_driver);
1983 #endif /* CONFIG_PNP */
1987 platform_device_unregister(wbsd_device);
1989 driver_unregister(&wbsd_driver);
1995 module_init(wbsd_drv_init);
1996 module_exit(wbsd_drv_exit);
1998 module_param(nopnp, uint, 0444);
2000 module_param(io, uint, 0444);
2001 module_param(irq, uint, 0444);
2002 module_param(dma, int, 0444);
2004 MODULE_LICENSE("GPL");
2005 MODULE_DESCRIPTION("Winbond W83L51xD SD/MMC card interface driver");
2006 MODULE_VERSION(DRIVER_VERSION);
2009 MODULE_PARM_DESC(nopnp, "Scan for device instead of relying on PNP. (default 0)");
2011 MODULE_PARM_DESC(io, "I/O base to allocate. Must be 8 byte aligned. (default 0x248)");
2012 MODULE_PARM_DESC(irq, "IRQ to allocate. (default 6)");
2013 MODULE_PARM_DESC(dma, "DMA channel to allocate. -1 for no DMA. (default 2)");