2 * linux/drivers/mmc/host/wbsd.c - Winbond W83L51xD SD/MMC driver
4 * Copyright (C) 2004-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.
14 * Changes to the FIFO system should be done with extreme care since
15 * the hardware is full of bugs related to the FIFO. Known issues are:
17 * - FIFO size field in FSR is always zero.
19 * - FIFO interrupts tend not to work as they should. Interrupts are
20 * triggered only for full/empty events, not for threshold values.
22 * - On APIC systems the FIFO empty interrupt is sometimes lost.
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/init.h>
28 #include <linux/ioport.h>
29 #include <linux/platform_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/scatterlist.h>
43 #define DRIVER_NAME "wbsd"
46 pr_debug(DRIVER_NAME ": " x)
47 #define DBGF(f, x...) \
48 pr_debug(DRIVER_NAME " [%s()]: " f, __func__ , ##x)
56 static const struct pnp_device_id pnp_dev_table[] = {
62 MODULE_DEVICE_TABLE(pnp, pnp_dev_table);
64 #endif /* CONFIG_PNP */
66 static const int config_ports[] = { 0x2E, 0x4E };
67 static const int unlock_codes[] = { 0x83, 0x87 };
69 static const int valid_ids[] = {
74 static unsigned int param_nopnp = 0;
76 static const unsigned int param_nopnp = 1;
78 static unsigned int param_io = 0x248;
79 static unsigned int param_irq = 6;
80 static int param_dma = 2;
86 static inline void wbsd_unlock_config(struct wbsd_host *host)
88 BUG_ON(host->config == 0);
90 outb(host->unlock_code, host->config);
91 outb(host->unlock_code, host->config);
94 static inline void wbsd_lock_config(struct wbsd_host *host)
96 BUG_ON(host->config == 0);
98 outb(LOCK_CODE, host->config);
101 static inline void wbsd_write_config(struct wbsd_host *host, u8 reg, u8 value)
103 BUG_ON(host->config == 0);
105 outb(reg, host->config);
106 outb(value, host->config + 1);
109 static inline u8 wbsd_read_config(struct wbsd_host *host, u8 reg)
111 BUG_ON(host->config == 0);
113 outb(reg, host->config);
114 return inb(host->config + 1);
117 static inline void wbsd_write_index(struct wbsd_host *host, u8 index, u8 value)
119 outb(index, host->base + WBSD_IDXR);
120 outb(value, host->base + WBSD_DATAR);
123 static inline u8 wbsd_read_index(struct wbsd_host *host, u8 index)
125 outb(index, host->base + WBSD_IDXR);
126 return inb(host->base + WBSD_DATAR);
133 static void wbsd_init_device(struct wbsd_host *host)
138 * Reset chip (SD/MMC part) and fifo.
140 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
141 setup |= WBSD_FIFO_RESET | WBSD_SOFT_RESET;
142 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
147 setup &= ~WBSD_DAT3_H;
148 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
149 host->flags &= ~WBSD_FIGNORE_DETECT;
152 * Read back default clock.
154 host->clk = wbsd_read_index(host, WBSD_IDX_CLK);
159 outb(WBSD_POWER_N, host->base + WBSD_CSR);
162 * Set maximum timeout.
164 wbsd_write_index(host, WBSD_IDX_TAAC, 0x7F);
167 * Test for card presence
169 if (inb(host->base + WBSD_CSR) & WBSD_CARDPRESENT)
170 host->flags |= WBSD_FCARD_PRESENT;
172 host->flags &= ~WBSD_FCARD_PRESENT;
175 * Enable interesting interrupts.
178 ier |= WBSD_EINT_CARD;
179 ier |= WBSD_EINT_FIFO_THRE;
180 ier |= WBSD_EINT_CRC;
181 ier |= WBSD_EINT_TIMEOUT;
184 outb(ier, host->base + WBSD_EIR);
189 inb(host->base + WBSD_ISR);
192 static void wbsd_reset(struct wbsd_host *host)
196 printk(KERN_ERR "%s: Resetting chip\n", mmc_hostname(host->mmc));
199 * Soft reset of chip (SD/MMC part).
201 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
202 setup |= WBSD_SOFT_RESET;
203 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
206 static void wbsd_request_end(struct wbsd_host *host, struct mmc_request *mrq)
208 unsigned long dmaflags;
210 if (host->dma >= 0) {
212 * Release ISA DMA controller.
214 dmaflags = claim_dma_lock();
215 disable_dma(host->dma);
216 clear_dma_ff(host->dma);
217 release_dma_lock(dmaflags);
220 * Disable DMA on host.
222 wbsd_write_index(host, WBSD_IDX_DMA, 0);
228 * MMC layer might call back into the driver so first unlock.
230 spin_unlock(&host->lock);
231 mmc_request_done(host->mmc, mrq);
232 spin_lock(&host->lock);
236 * Scatter/gather functions
239 static inline void wbsd_init_sg(struct wbsd_host *host, struct mmc_data *data)
242 * Get info. about SG list from data structure.
244 host->cur_sg = data->sg;
245 host->num_sg = data->sg_len;
248 host->remain = host->cur_sg->length;
251 static inline int wbsd_next_sg(struct wbsd_host *host)
254 * Skip to next SG entry.
262 if (host->num_sg > 0) {
264 host->remain = host->cur_sg->length;
270 static inline char *wbsd_sg_to_buffer(struct wbsd_host *host)
272 return sg_virt(host->cur_sg);
275 static inline void wbsd_sg_to_dma(struct wbsd_host *host, struct mmc_data *data)
278 struct scatterlist *sg;
279 char *dmabuf = host->dma_buffer;
285 for (i = 0; i < len; i++) {
286 sgbuf = sg_virt(&sg[i]);
287 memcpy(dmabuf, sgbuf, sg[i].length);
288 dmabuf += sg[i].length;
292 static inline void wbsd_dma_to_sg(struct wbsd_host *host, struct mmc_data *data)
295 struct scatterlist *sg;
296 char *dmabuf = host->dma_buffer;
302 for (i = 0; i < len; i++) {
303 sgbuf = sg_virt(&sg[i]);
304 memcpy(sgbuf, dmabuf, sg[i].length);
305 dmabuf += sg[i].length;
313 static inline void wbsd_get_short_reply(struct wbsd_host *host,
314 struct mmc_command *cmd)
317 * Correct response type?
319 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_SHORT) {
320 cmd->error = -EILSEQ;
324 cmd->resp[0] = wbsd_read_index(host, WBSD_IDX_RESP12) << 24;
325 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP13) << 16;
326 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP14) << 8;
327 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP15) << 0;
328 cmd->resp[1] = wbsd_read_index(host, WBSD_IDX_RESP16) << 24;
331 static inline void wbsd_get_long_reply(struct wbsd_host *host,
332 struct mmc_command *cmd)
337 * Correct response type?
339 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_LONG) {
340 cmd->error = -EILSEQ;
344 for (i = 0; i < 4; i++) {
346 wbsd_read_index(host, WBSD_IDX_RESP1 + i * 4) << 24;
348 wbsd_read_index(host, WBSD_IDX_RESP2 + i * 4) << 16;
350 wbsd_read_index(host, WBSD_IDX_RESP3 + i * 4) << 8;
352 wbsd_read_index(host, WBSD_IDX_RESP4 + i * 4) << 0;
356 static void wbsd_send_command(struct wbsd_host *host, struct mmc_command *cmd)
362 * Clear accumulated ISR. The interrupt routine
363 * will fill this one with events that occur during
369 * Send the command (CRC calculated by host).
371 outb(cmd->opcode, host->base + WBSD_CMDR);
372 for (i = 3; i >= 0; i--)
373 outb((cmd->arg >> (i * 8)) & 0xff, host->base + WBSD_CMDR);
378 * Wait for the request to complete.
381 status = wbsd_read_index(host, WBSD_IDX_STATUS);
382 } while (status & WBSD_CARDTRAFFIC);
385 * Do we expect a reply?
387 if (cmd->flags & MMC_RSP_PRESENT) {
394 if (isr & WBSD_INT_CARD)
395 cmd->error = -ENOMEDIUM;
397 else if (isr & WBSD_INT_TIMEOUT)
398 cmd->error = -ETIMEDOUT;
400 else if ((cmd->flags & MMC_RSP_CRC) && (isr & WBSD_INT_CRC))
401 cmd->error = -EILSEQ;
404 if (cmd->flags & MMC_RSP_136)
405 wbsd_get_long_reply(host, cmd);
407 wbsd_get_short_reply(host, cmd);
416 static void wbsd_empty_fifo(struct wbsd_host *host)
418 struct mmc_data *data = host->mrq->cmd->data;
423 * Handle excessive data.
425 if (host->num_sg == 0)
428 buffer = wbsd_sg_to_buffer(host) + host->offset;
431 * Drain the fifo. This has a tendency to loop longer
432 * than the FIFO length (usually one block).
434 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_EMPTY)) {
436 * The size field in the FSR is broken so we have to
439 if (fsr & WBSD_FIFO_FULL)
441 else if (fsr & WBSD_FIFO_FUTHRE)
446 for (i = 0; i < fifo; i++) {
447 *buffer = inb(host->base + WBSD_DFR);
452 data->bytes_xfered++;
455 * End of scatter list entry?
457 if (host->remain == 0) {
459 * Get next entry. Check if last.
461 if (!wbsd_next_sg(host))
464 buffer = wbsd_sg_to_buffer(host);
470 * This is a very dirty hack to solve a
471 * hardware problem. The chip doesn't trigger
472 * FIFO threshold interrupts properly.
474 if ((data->blocks * data->blksz - data->bytes_xfered) < 16)
475 tasklet_schedule(&host->fifo_tasklet);
478 static void wbsd_fill_fifo(struct wbsd_host *host)
480 struct mmc_data *data = host->mrq->cmd->data;
485 * Check that we aren't being called after the
486 * entire buffer has been transfered.
488 if (host->num_sg == 0)
491 buffer = wbsd_sg_to_buffer(host) + host->offset;
494 * Fill the fifo. This has a tendency to loop longer
495 * than the FIFO length (usually one block).
497 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_FULL)) {
499 * The size field in the FSR is broken so we have to
502 if (fsr & WBSD_FIFO_EMPTY)
504 else if (fsr & WBSD_FIFO_EMTHRE)
509 for (i = 16; i > fifo; i--) {
510 outb(*buffer, host->base + WBSD_DFR);
515 data->bytes_xfered++;
518 * End of scatter list entry?
520 if (host->remain == 0) {
522 * Get next entry. Check if last.
524 if (!wbsd_next_sg(host))
527 buffer = wbsd_sg_to_buffer(host);
533 * The controller stops sending interrupts for
534 * 'FIFO empty' under certain conditions. So we
535 * need to be a bit more pro-active.
537 tasklet_schedule(&host->fifo_tasklet);
540 static void wbsd_prepare_data(struct wbsd_host *host, struct mmc_data *data)
544 unsigned long dmaflags;
550 size = data->blocks * data->blksz;
553 * Check timeout values for overflow.
554 * (Yes, some cards cause this value to overflow).
556 if (data->timeout_ns > 127000000)
557 wbsd_write_index(host, WBSD_IDX_TAAC, 127);
559 wbsd_write_index(host, WBSD_IDX_TAAC,
560 data->timeout_ns / 1000000);
563 if (data->timeout_clks > 255)
564 wbsd_write_index(host, WBSD_IDX_NSAC, 255);
566 wbsd_write_index(host, WBSD_IDX_NSAC, data->timeout_clks);
569 * Inform the chip of how large blocks will be
570 * sent. It needs this to determine when to
573 * Space for CRC must be included in the size.
574 * Two bytes are needed for each data line.
576 if (host->bus_width == MMC_BUS_WIDTH_1) {
577 blksize = data->blksz + 2;
579 wbsd_write_index(host, WBSD_IDX_PBSMSB, (blksize >> 4) & 0xF0);
580 wbsd_write_index(host, WBSD_IDX_PBSLSB, blksize & 0xFF);
581 } else if (host->bus_width == MMC_BUS_WIDTH_4) {
582 blksize = data->blksz + 2 * 4;
584 wbsd_write_index(host, WBSD_IDX_PBSMSB,
585 ((blksize >> 4) & 0xF0) | WBSD_DATA_WIDTH);
586 wbsd_write_index(host, WBSD_IDX_PBSLSB, blksize & 0xFF);
588 data->error = -EINVAL;
593 * Clear the FIFO. This is needed even for DMA
594 * transfers since the chip still uses the FIFO
597 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
598 setup |= WBSD_FIFO_RESET;
599 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
604 if (host->dma >= 0) {
606 * The buffer for DMA is only 64 kB.
608 BUG_ON(size > 0x10000);
609 if (size > 0x10000) {
610 data->error = -EINVAL;
615 * Transfer data from the SG list to
618 if (data->flags & MMC_DATA_WRITE)
619 wbsd_sg_to_dma(host, data);
622 * Initialise the ISA DMA controller.
624 dmaflags = claim_dma_lock();
625 disable_dma(host->dma);
626 clear_dma_ff(host->dma);
627 if (data->flags & MMC_DATA_READ)
628 set_dma_mode(host->dma, DMA_MODE_READ & ~0x40);
630 set_dma_mode(host->dma, DMA_MODE_WRITE & ~0x40);
631 set_dma_addr(host->dma, host->dma_addr);
632 set_dma_count(host->dma, size);
634 enable_dma(host->dma);
635 release_dma_lock(dmaflags);
638 * Enable DMA on the host.
640 wbsd_write_index(host, WBSD_IDX_DMA, WBSD_DMA_ENABLE);
643 * This flag is used to keep printk
644 * output to a minimum.
649 * Initialise the SG list.
651 wbsd_init_sg(host, data);
656 wbsd_write_index(host, WBSD_IDX_DMA, 0);
659 * Set up FIFO threshold levels (and fill
660 * buffer if doing a write).
662 if (data->flags & MMC_DATA_READ) {
663 wbsd_write_index(host, WBSD_IDX_FIFOEN,
664 WBSD_FIFOEN_FULL | 8);
666 wbsd_write_index(host, WBSD_IDX_FIFOEN,
667 WBSD_FIFOEN_EMPTY | 8);
668 wbsd_fill_fifo(host);
675 static void wbsd_finish_data(struct wbsd_host *host, struct mmc_data *data)
677 unsigned long dmaflags;
681 WARN_ON(host->mrq == NULL);
684 * Send a stop command if needed.
687 wbsd_send_command(host, data->stop);
690 * Wait for the controller to leave data
694 status = wbsd_read_index(host, WBSD_IDX_STATUS);
695 } while (status & (WBSD_BLOCK_READ | WBSD_BLOCK_WRITE));
700 if (host->dma >= 0) {
702 * Disable DMA on the host.
704 wbsd_write_index(host, WBSD_IDX_DMA, 0);
707 * Turn of ISA DMA controller.
709 dmaflags = claim_dma_lock();
710 disable_dma(host->dma);
711 clear_dma_ff(host->dma);
712 count = get_dma_residue(host->dma);
713 release_dma_lock(dmaflags);
715 data->bytes_xfered = host->mrq->data->blocks *
716 host->mrq->data->blksz - count;
717 data->bytes_xfered -= data->bytes_xfered % data->blksz;
723 printk(KERN_ERR "%s: Incomplete DMA transfer. "
725 mmc_hostname(host->mmc), count);
731 * Transfer data from DMA buffer to
734 if (data->flags & MMC_DATA_READ)
735 wbsd_dma_to_sg(host, data);
739 if (data->bytes_xfered)
740 data->bytes_xfered -= data->blksz;
744 wbsd_request_end(host, host->mrq);
747 /*****************************************************************************\
749 * MMC layer callbacks *
751 \*****************************************************************************/
753 static void wbsd_request(struct mmc_host *mmc, struct mmc_request *mrq)
755 struct wbsd_host *host = mmc_priv(mmc);
756 struct mmc_command *cmd;
759 * Disable tasklets to avoid a deadlock.
761 spin_lock_bh(&host->lock);
763 BUG_ON(host->mrq != NULL);
770 * Check that there is actually a card in the slot.
772 if (!(host->flags & WBSD_FCARD_PRESENT)) {
773 cmd->error = -ENOMEDIUM;
779 * The hardware is so delightfully stupid that it has a list
780 * of "data" commands. If a command isn't on this list, it'll
781 * just go back to the idle state and won't send any data
784 switch (cmd->opcode) {
798 /* ACMDs. We don't keep track of state, so we just treat them
799 * like any other command. */
804 #ifdef CONFIG_MMC_DEBUG
805 printk(KERN_WARNING "%s: Data command %d is not "
806 "supported by this controller.\n",
807 mmc_hostname(host->mmc), cmd->opcode);
809 cmd->error = -EINVAL;
816 * Does the request include data?
819 wbsd_prepare_data(host, cmd->data);
821 if (cmd->data->error)
825 wbsd_send_command(host, cmd);
828 * If this is a data transfer the request
829 * will be finished after the data has
832 if (cmd->data && !cmd->error) {
834 * Dirty fix for hardware bug.
837 tasklet_schedule(&host->fifo_tasklet);
839 spin_unlock_bh(&host->lock);
845 wbsd_request_end(host, mrq);
847 spin_unlock_bh(&host->lock);
850 static void wbsd_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
852 struct wbsd_host *host = mmc_priv(mmc);
855 spin_lock_bh(&host->lock);
858 * Reset the chip on each power off.
859 * Should clear out any weird states.
861 if (ios->power_mode == MMC_POWER_OFF)
862 wbsd_init_device(host);
864 if (ios->clock >= 24000000)
866 else if (ios->clock >= 16000000)
868 else if (ios->clock >= 12000000)
874 * Only write to the clock register when
875 * there is an actual change.
877 if (clk != host->clk) {
878 wbsd_write_index(host, WBSD_IDX_CLK, clk);
885 if (ios->power_mode != MMC_POWER_OFF) {
886 pwr = inb(host->base + WBSD_CSR);
887 pwr &= ~WBSD_POWER_N;
888 outb(pwr, host->base + WBSD_CSR);
892 * MMC cards need to have pin 1 high during init.
893 * It wreaks havoc with the card detection though so
894 * that needs to be disabled.
896 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
897 if (ios->chip_select == MMC_CS_HIGH) {
898 BUG_ON(ios->bus_width != MMC_BUS_WIDTH_1);
899 setup |= WBSD_DAT3_H;
900 host->flags |= WBSD_FIGNORE_DETECT;
902 if (setup & WBSD_DAT3_H) {
903 setup &= ~WBSD_DAT3_H;
906 * We cannot resume card detection immediatly
907 * because of capacitance and delays in the chip.
909 mod_timer(&host->ignore_timer, jiffies + HZ / 100);
912 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
915 * Store bus width for later. Will be used when
916 * setting up the data transfer.
918 host->bus_width = ios->bus_width;
920 spin_unlock_bh(&host->lock);
923 static int wbsd_get_ro(struct mmc_host *mmc)
925 struct wbsd_host *host = mmc_priv(mmc);
928 spin_lock_bh(&host->lock);
930 csr = inb(host->base + WBSD_CSR);
932 outb(csr, host->base + WBSD_CSR);
936 csr = inb(host->base + WBSD_CSR);
938 outb(csr, host->base + WBSD_CSR);
940 spin_unlock_bh(&host->lock);
942 return !!(csr & WBSD_WRPT);
945 static const struct mmc_host_ops wbsd_ops = {
946 .request = wbsd_request,
947 .set_ios = wbsd_set_ios,
948 .get_ro = wbsd_get_ro,
951 /*****************************************************************************\
953 * Interrupt handling *
955 \*****************************************************************************/
958 * Helper function to reset detection ignore
961 static void wbsd_reset_ignore(unsigned long data)
963 struct wbsd_host *host = (struct wbsd_host *)data;
965 BUG_ON(host == NULL);
967 DBG("Resetting card detection ignore\n");
969 spin_lock_bh(&host->lock);
971 host->flags &= ~WBSD_FIGNORE_DETECT;
974 * Card status might have changed during the
977 tasklet_schedule(&host->card_tasklet);
979 spin_unlock_bh(&host->lock);
986 static inline struct mmc_data *wbsd_get_data(struct wbsd_host *host)
992 WARN_ON(!host->mrq->cmd);
996 WARN_ON(!host->mrq->cmd->data);
997 if (!host->mrq->cmd->data)
1000 return host->mrq->cmd->data;
1003 static void wbsd_tasklet_card(unsigned long param)
1005 struct wbsd_host *host = (struct wbsd_host *)param;
1009 spin_lock(&host->lock);
1011 if (host->flags & WBSD_FIGNORE_DETECT) {
1012 spin_unlock(&host->lock);
1016 csr = inb(host->base + WBSD_CSR);
1017 WARN_ON(csr == 0xff);
1019 if (csr & WBSD_CARDPRESENT) {
1020 if (!(host->flags & WBSD_FCARD_PRESENT)) {
1021 DBG("Card inserted\n");
1022 host->flags |= WBSD_FCARD_PRESENT;
1026 } else if (host->flags & WBSD_FCARD_PRESENT) {
1027 DBG("Card removed\n");
1028 host->flags &= ~WBSD_FCARD_PRESENT;
1031 printk(KERN_ERR "%s: Card removed during transfer!\n",
1032 mmc_hostname(host->mmc));
1035 host->mrq->cmd->error = -ENOMEDIUM;
1036 tasklet_schedule(&host->finish_tasklet);
1043 * Unlock first since we might get a call back.
1046 spin_unlock(&host->lock);
1049 mmc_detect_change(host->mmc, msecs_to_jiffies(delay));
1052 static void wbsd_tasklet_fifo(unsigned long param)
1054 struct wbsd_host *host = (struct wbsd_host *)param;
1055 struct mmc_data *data;
1057 spin_lock(&host->lock);
1062 data = wbsd_get_data(host);
1066 if (data->flags & MMC_DATA_WRITE)
1067 wbsd_fill_fifo(host);
1069 wbsd_empty_fifo(host);
1074 if (host->num_sg == 0) {
1075 wbsd_write_index(host, WBSD_IDX_FIFOEN, 0);
1076 tasklet_schedule(&host->finish_tasklet);
1080 spin_unlock(&host->lock);
1083 static void wbsd_tasklet_crc(unsigned long param)
1085 struct wbsd_host *host = (struct wbsd_host *)param;
1086 struct mmc_data *data;
1088 spin_lock(&host->lock);
1093 data = wbsd_get_data(host);
1097 DBGF("CRC error\n");
1099 data->error = -EILSEQ;
1101 tasklet_schedule(&host->finish_tasklet);
1104 spin_unlock(&host->lock);
1107 static void wbsd_tasklet_timeout(unsigned long param)
1109 struct wbsd_host *host = (struct wbsd_host *)param;
1110 struct mmc_data *data;
1112 spin_lock(&host->lock);
1117 data = wbsd_get_data(host);
1123 data->error = -ETIMEDOUT;
1125 tasklet_schedule(&host->finish_tasklet);
1128 spin_unlock(&host->lock);
1131 static void wbsd_tasklet_finish(unsigned long param)
1133 struct wbsd_host *host = (struct wbsd_host *)param;
1134 struct mmc_data *data;
1136 spin_lock(&host->lock);
1138 WARN_ON(!host->mrq);
1142 data = wbsd_get_data(host);
1146 wbsd_finish_data(host, data);
1149 spin_unlock(&host->lock);
1153 * Interrupt handling
1156 static irqreturn_t wbsd_irq(int irq, void *dev_id)
1158 struct wbsd_host *host = dev_id;
1161 isr = inb(host->base + WBSD_ISR);
1164 * Was it actually our hardware that caused the interrupt?
1166 if (isr == 0xff || isr == 0x00)
1172 * Schedule tasklets as needed.
1174 if (isr & WBSD_INT_CARD)
1175 tasklet_schedule(&host->card_tasklet);
1176 if (isr & WBSD_INT_FIFO_THRE)
1177 tasklet_schedule(&host->fifo_tasklet);
1178 if (isr & WBSD_INT_CRC)
1179 tasklet_hi_schedule(&host->crc_tasklet);
1180 if (isr & WBSD_INT_TIMEOUT)
1181 tasklet_hi_schedule(&host->timeout_tasklet);
1182 if (isr & WBSD_INT_TC)
1183 tasklet_schedule(&host->finish_tasklet);
1188 /*****************************************************************************\
1190 * Device initialisation and shutdown *
1192 \*****************************************************************************/
1195 * Allocate/free MMC structure.
1198 static int __devinit wbsd_alloc_mmc(struct device *dev)
1200 struct mmc_host *mmc;
1201 struct wbsd_host *host;
1204 * Allocate MMC structure.
1206 mmc = mmc_alloc_host(sizeof(struct wbsd_host), dev);
1210 host = mmc_priv(mmc);
1216 * Set host parameters.
1218 mmc->ops = &wbsd_ops;
1219 mmc->f_min = 375000;
1220 mmc->f_max = 24000000;
1221 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
1222 mmc->caps = MMC_CAP_4_BIT_DATA;
1224 spin_lock_init(&host->lock);
1229 init_timer(&host->ignore_timer);
1230 host->ignore_timer.data = (unsigned long)host;
1231 host->ignore_timer.function = wbsd_reset_ignore;
1234 * Maximum number of segments. Worst case is one sector per segment
1235 * so this will be 64kB/512.
1237 mmc->max_hw_segs = 128;
1238 mmc->max_phys_segs = 128;
1241 * Maximum request size. Also limited by 64KiB buffer.
1243 mmc->max_req_size = 65536;
1246 * Maximum segment size. Could be one segment with the maximum number
1249 mmc->max_seg_size = mmc->max_req_size;
1252 * Maximum block size. We have 12 bits (= 4095) but have to subtract
1253 * space for CRC. So the maximum is 4095 - 4*2 = 4087.
1255 mmc->max_blk_size = 4087;
1258 * Maximum block count. There is no real limit so the maximum
1259 * request size will be the only restriction.
1261 mmc->max_blk_count = mmc->max_req_size;
1263 dev_set_drvdata(dev, mmc);
1268 static void wbsd_free_mmc(struct device *dev)
1270 struct mmc_host *mmc;
1271 struct wbsd_host *host;
1273 mmc = dev_get_drvdata(dev);
1277 host = mmc_priv(mmc);
1278 BUG_ON(host == NULL);
1280 del_timer_sync(&host->ignore_timer);
1284 dev_set_drvdata(dev, NULL);
1288 * Scan for known chip id:s
1291 static int __devinit wbsd_scan(struct wbsd_host *host)
1297 * Iterate through all ports, all codes to
1298 * find hardware that is in our known list.
1300 for (i = 0; i < ARRAY_SIZE(config_ports); i++) {
1301 if (!request_region(config_ports[i], 2, DRIVER_NAME))
1304 for (j = 0; j < ARRAY_SIZE(unlock_codes); j++) {
1307 host->config = config_ports[i];
1308 host->unlock_code = unlock_codes[j];
1310 wbsd_unlock_config(host);
1312 outb(WBSD_CONF_ID_HI, config_ports[i]);
1313 id = inb(config_ports[i] + 1) << 8;
1315 outb(WBSD_CONF_ID_LO, config_ports[i]);
1316 id |= inb(config_ports[i] + 1);
1318 wbsd_lock_config(host);
1320 for (k = 0; k < ARRAY_SIZE(valid_ids); k++) {
1321 if (id == valid_ids[k]) {
1329 DBG("Unknown hardware (id %x) found at %x\n",
1330 id, config_ports[i]);
1334 release_region(config_ports[i], 2);
1338 host->unlock_code = 0;
1344 * Allocate/free io port ranges
1347 static int __devinit wbsd_request_region(struct wbsd_host *host, int base)
1352 if (!request_region(base, 8, DRIVER_NAME))
1360 static void wbsd_release_regions(struct wbsd_host *host)
1363 release_region(host->base, 8);
1368 release_region(host->config, 2);
1374 * Allocate/free DMA port and buffer
1377 static void __devinit wbsd_request_dma(struct wbsd_host *host, int dma)
1382 if (request_dma(dma, DRIVER_NAME))
1386 * We need to allocate a special buffer in
1387 * order for ISA to be able to DMA to it.
1389 host->dma_buffer = kmalloc(WBSD_DMA_SIZE,
1390 GFP_NOIO | GFP_DMA | __GFP_REPEAT | __GFP_NOWARN);
1391 if (!host->dma_buffer)
1395 * Translate the address to a physical address.
1397 host->dma_addr = dma_map_single(mmc_dev(host->mmc), host->dma_buffer,
1398 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1401 * ISA DMA must be aligned on a 64k basis.
1403 if ((host->dma_addr & 0xffff) != 0)
1406 * ISA cannot access memory above 16 MB.
1408 else if (host->dma_addr >= 0x1000000)
1417 * If we've gotten here then there is some kind of alignment bug
1421 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1422 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1425 kfree(host->dma_buffer);
1426 host->dma_buffer = NULL;
1432 printk(KERN_WARNING DRIVER_NAME ": Unable to allocate DMA %d. "
1433 "Falling back on FIFO.\n", dma);
1436 static void wbsd_release_dma(struct wbsd_host *host)
1438 if (host->dma_addr) {
1439 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1440 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1442 kfree(host->dma_buffer);
1444 free_dma(host->dma);
1447 host->dma_buffer = NULL;
1452 * Allocate/free IRQ.
1455 static int __devinit wbsd_request_irq(struct wbsd_host *host, int irq)
1460 * Set up tasklets. Must be done before requesting interrupt.
1462 tasklet_init(&host->card_tasklet, wbsd_tasklet_card,
1463 (unsigned long)host);
1464 tasklet_init(&host->fifo_tasklet, wbsd_tasklet_fifo,
1465 (unsigned long)host);
1466 tasklet_init(&host->crc_tasklet, wbsd_tasklet_crc,
1467 (unsigned long)host);
1468 tasklet_init(&host->timeout_tasklet, wbsd_tasklet_timeout,
1469 (unsigned long)host);
1470 tasklet_init(&host->finish_tasklet, wbsd_tasklet_finish,
1471 (unsigned long)host);
1474 * Allocate interrupt.
1476 ret = request_irq(irq, wbsd_irq, IRQF_SHARED, DRIVER_NAME, host);
1485 static void wbsd_release_irq(struct wbsd_host *host)
1490 free_irq(host->irq, host);
1494 tasklet_kill(&host->card_tasklet);
1495 tasklet_kill(&host->fifo_tasklet);
1496 tasklet_kill(&host->crc_tasklet);
1497 tasklet_kill(&host->timeout_tasklet);
1498 tasklet_kill(&host->finish_tasklet);
1502 * Allocate all resources for the host.
1505 static int __devinit wbsd_request_resources(struct wbsd_host *host,
1506 int base, int irq, int dma)
1511 * Allocate I/O ports.
1513 ret = wbsd_request_region(host, base);
1518 * Allocate interrupt.
1520 ret = wbsd_request_irq(host, irq);
1527 wbsd_request_dma(host, dma);
1533 * Release all resources for the host.
1536 static void wbsd_release_resources(struct wbsd_host *host)
1538 wbsd_release_dma(host);
1539 wbsd_release_irq(host);
1540 wbsd_release_regions(host);
1544 * Configure the resources the chip should use.
1547 static void wbsd_chip_config(struct wbsd_host *host)
1549 wbsd_unlock_config(host);
1554 wbsd_write_config(host, WBSD_CONF_SWRST, 1);
1555 wbsd_write_config(host, WBSD_CONF_SWRST, 0);
1558 * Select SD/MMC function.
1560 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1563 * Set up card detection.
1565 wbsd_write_config(host, WBSD_CONF_PINS, WBSD_PINS_DETECT_GP11);
1570 wbsd_write_config(host, WBSD_CONF_PORT_HI, host->base >> 8);
1571 wbsd_write_config(host, WBSD_CONF_PORT_LO, host->base & 0xff);
1573 wbsd_write_config(host, WBSD_CONF_IRQ, host->irq);
1576 wbsd_write_config(host, WBSD_CONF_DRQ, host->dma);
1579 * Enable and power up chip.
1581 wbsd_write_config(host, WBSD_CONF_ENABLE, 1);
1582 wbsd_write_config(host, WBSD_CONF_POWER, 0x20);
1584 wbsd_lock_config(host);
1588 * Check that configured resources are correct.
1591 static int wbsd_chip_validate(struct wbsd_host *host)
1595 wbsd_unlock_config(host);
1598 * Select SD/MMC function.
1600 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1603 * Read configuration.
1605 base = wbsd_read_config(host, WBSD_CONF_PORT_HI) << 8;
1606 base |= wbsd_read_config(host, WBSD_CONF_PORT_LO);
1608 irq = wbsd_read_config(host, WBSD_CONF_IRQ);
1610 dma = wbsd_read_config(host, WBSD_CONF_DRQ);
1612 wbsd_lock_config(host);
1615 * Validate against given configuration.
1617 if (base != host->base)
1619 if (irq != host->irq)
1621 if ((dma != host->dma) && (host->dma != -1))
1628 * Powers down the SD function
1631 static void wbsd_chip_poweroff(struct wbsd_host *host)
1633 wbsd_unlock_config(host);
1635 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1636 wbsd_write_config(host, WBSD_CONF_ENABLE, 0);
1638 wbsd_lock_config(host);
1641 /*****************************************************************************\
1643 * Devices setup and shutdown *
1645 \*****************************************************************************/
1647 static int __devinit wbsd_init(struct device *dev, int base, int irq, int dma,
1650 struct wbsd_host *host = NULL;
1651 struct mmc_host *mmc = NULL;
1654 ret = wbsd_alloc_mmc(dev);
1658 mmc = dev_get_drvdata(dev);
1659 host = mmc_priv(mmc);
1662 * Scan for hardware.
1664 ret = wbsd_scan(host);
1666 if (pnp && (ret == -ENODEV)) {
1667 printk(KERN_WARNING DRIVER_NAME
1668 ": Unable to confirm device presence. You may "
1669 "experience lock-ups.\n");
1677 * Request resources.
1679 ret = wbsd_request_resources(host, base, irq, dma);
1681 wbsd_release_resources(host);
1687 * See if chip needs to be configured.
1690 if ((host->config != 0) && !wbsd_chip_validate(host)) {
1691 printk(KERN_WARNING DRIVER_NAME
1692 ": PnP active but chip not configured! "
1693 "You probably have a buggy BIOS. "
1694 "Configuring chip manually.\n");
1695 wbsd_chip_config(host);
1698 wbsd_chip_config(host);
1701 * Power Management stuff. No idea how this works.
1706 wbsd_unlock_config(host);
1707 wbsd_write_config(host, WBSD_CONF_PME, 0xA0);
1708 wbsd_lock_config(host);
1712 * Allow device to initialise itself properly.
1717 * Reset the chip into a known state.
1719 wbsd_init_device(host);
1723 printk(KERN_INFO "%s: W83L51xD", mmc_hostname(mmc));
1724 if (host->chip_id != 0)
1725 printk(" id %x", (int)host->chip_id);
1726 printk(" at 0x%x irq %d", (int)host->base, (int)host->irq);
1728 printk(" dma %d", (int)host->dma);
1738 static void __devexit wbsd_shutdown(struct device *dev, int pnp)
1740 struct mmc_host *mmc = dev_get_drvdata(dev);
1741 struct wbsd_host *host;
1746 host = mmc_priv(mmc);
1748 mmc_remove_host(mmc);
1751 * Power down the SD/MMC function.
1754 wbsd_chip_poweroff(host);
1756 wbsd_release_resources(host);
1765 static int __devinit wbsd_probe(struct platform_device *dev)
1767 /* Use the module parameters for resources */
1768 return wbsd_init(&dev->dev, param_io, param_irq, param_dma, 0);
1771 static int __devexit wbsd_remove(struct platform_device *dev)
1773 wbsd_shutdown(&dev->dev, 0);
1784 static int __devinit
1785 wbsd_pnp_probe(struct pnp_dev *pnpdev, const struct pnp_device_id *dev_id)
1790 * Get resources from PnP layer.
1792 io = pnp_port_start(pnpdev, 0);
1793 irq = pnp_irq(pnpdev, 0);
1794 if (pnp_dma_valid(pnpdev, 0))
1795 dma = pnp_dma(pnpdev, 0);
1799 DBGF("PnP resources: port %3x irq %d dma %d\n", io, irq, dma);
1801 return wbsd_init(&pnpdev->dev, io, irq, dma, 1);
1804 static void __devexit wbsd_pnp_remove(struct pnp_dev *dev)
1806 wbsd_shutdown(&dev->dev, 1);
1809 #endif /* CONFIG_PNP */
1817 static int wbsd_suspend(struct wbsd_host *host, pm_message_t state)
1819 BUG_ON(host == NULL);
1821 return mmc_suspend_host(host->mmc, state);
1824 static int wbsd_resume(struct wbsd_host *host)
1826 BUG_ON(host == NULL);
1828 wbsd_init_device(host);
1830 return mmc_resume_host(host->mmc);
1833 static int wbsd_platform_suspend(struct platform_device *dev,
1836 struct mmc_host *mmc = platform_get_drvdata(dev);
1837 struct wbsd_host *host;
1843 DBGF("Suspending...\n");
1845 host = mmc_priv(mmc);
1847 ret = wbsd_suspend(host, state);
1851 wbsd_chip_poweroff(host);
1856 static int wbsd_platform_resume(struct platform_device *dev)
1858 struct mmc_host *mmc = platform_get_drvdata(dev);
1859 struct wbsd_host *host;
1864 DBGF("Resuming...\n");
1866 host = mmc_priv(mmc);
1868 wbsd_chip_config(host);
1871 * Allow device to initialise itself properly.
1875 return wbsd_resume(host);
1880 static int wbsd_pnp_suspend(struct pnp_dev *pnp_dev, pm_message_t state)
1882 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1883 struct wbsd_host *host;
1888 DBGF("Suspending...\n");
1890 host = mmc_priv(mmc);
1892 return wbsd_suspend(host, state);
1895 static int wbsd_pnp_resume(struct pnp_dev *pnp_dev)
1897 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1898 struct wbsd_host *host;
1903 DBGF("Resuming...\n");
1905 host = mmc_priv(mmc);
1908 * See if chip needs to be configured.
1910 if (host->config != 0) {
1911 if (!wbsd_chip_validate(host)) {
1912 printk(KERN_WARNING DRIVER_NAME
1913 ": PnP active but chip not configured! "
1914 "You probably have a buggy BIOS. "
1915 "Configuring chip manually.\n");
1916 wbsd_chip_config(host);
1921 * Allow device to initialise itself properly.
1925 return wbsd_resume(host);
1928 #endif /* CONFIG_PNP */
1930 #else /* CONFIG_PM */
1932 #define wbsd_platform_suspend NULL
1933 #define wbsd_platform_resume NULL
1935 #define wbsd_pnp_suspend NULL
1936 #define wbsd_pnp_resume NULL
1938 #endif /* CONFIG_PM */
1940 static struct platform_device *wbsd_device;
1942 static struct platform_driver wbsd_driver = {
1943 .probe = wbsd_probe,
1944 .remove = __devexit_p(wbsd_remove),
1946 .suspend = wbsd_platform_suspend,
1947 .resume = wbsd_platform_resume,
1949 .name = DRIVER_NAME,
1950 .owner = THIS_MODULE,
1956 static struct pnp_driver wbsd_pnp_driver = {
1957 .name = DRIVER_NAME,
1958 .id_table = pnp_dev_table,
1959 .probe = wbsd_pnp_probe,
1960 .remove = __devexit_p(wbsd_pnp_remove),
1962 .suspend = wbsd_pnp_suspend,
1963 .resume = wbsd_pnp_resume,
1966 #endif /* CONFIG_PNP */
1969 * Module loading/unloading
1972 static int __init wbsd_drv_init(void)
1976 printk(KERN_INFO DRIVER_NAME
1977 ": Winbond W83L51xD SD/MMC card interface driver\n");
1978 printk(KERN_INFO DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1983 result = pnp_register_driver(&wbsd_pnp_driver);
1987 #endif /* CONFIG_PNP */
1990 result = platform_driver_register(&wbsd_driver);
1994 wbsd_device = platform_device_alloc(DRIVER_NAME, -1);
1996 platform_driver_unregister(&wbsd_driver);
2000 result = platform_device_add(wbsd_device);
2002 platform_device_put(wbsd_device);
2003 platform_driver_unregister(&wbsd_driver);
2011 static void __exit wbsd_drv_exit(void)
2016 pnp_unregister_driver(&wbsd_pnp_driver);
2018 #endif /* CONFIG_PNP */
2021 platform_device_unregister(wbsd_device);
2023 platform_driver_unregister(&wbsd_driver);
2029 module_init(wbsd_drv_init);
2030 module_exit(wbsd_drv_exit);
2032 module_param_named(nopnp, param_nopnp, uint, 0444);
2034 module_param_named(io, param_io, uint, 0444);
2035 module_param_named(irq, param_irq, uint, 0444);
2036 module_param_named(dma, param_dma, int, 0444);
2038 MODULE_LICENSE("GPL");
2039 MODULE_AUTHOR("Pierre Ossman <drzeus@drzeus.cx>");
2040 MODULE_DESCRIPTION("Winbond W83L51xD SD/MMC card interface driver");
2043 MODULE_PARM_DESC(nopnp, "Scan for device instead of relying on PNP. (default 0)");
2045 MODULE_PARM_DESC(io, "I/O base to allocate. Must be 8 byte aligned. (default 0x248)");
2046 MODULE_PARM_DESC(irq, "IRQ to allocate. (default 6)");
2047 MODULE_PARM_DESC(dma, "DMA channel to allocate. -1 for no DMA. (default 2)");