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>
39 #include <asm/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 nopnp = 0;
76 static const unsigned int nopnp = 1;
78 static unsigned int io = 0x248;
79 static unsigned int irq = 6;
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 page_address(host->cur_sg->page) + host->cur_sg->offset;
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 = page_address(sg[i].page) + sg[i].offset;
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 = page_address(sg[i].page) + sg[i].offset;
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 = MMC_ERR_INVALID;
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 = MMC_ERR_INVALID;
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);
375 cmd->error = MMC_ERR_NONE;
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 = MMC_ERR_TIMEOUT;
397 else if (isr & WBSD_INT_TIMEOUT)
398 cmd->error = MMC_ERR_TIMEOUT;
400 else if ((cmd->flags & MMC_RSP_CRC) && (isr & WBSD_INT_CRC))
401 cmd->error = MMC_ERR_BADCRC;
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 = MMC_ERR_INVALID;
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 = MMC_ERR_INVALID;
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);
672 data->error = MMC_ERR_NONE;
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);
727 if (data->error == MMC_ERR_NONE)
728 data->error = MMC_ERR_FAILED;
731 * Transfer data from DMA buffer to
734 if (data->flags & MMC_DATA_READ)
735 wbsd_dma_to_sg(host, data);
738 if (data->error != MMC_ERR_NONE) {
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 * If there is no card in the slot then
771 * timeout immediatly.
773 if (!(host->flags & WBSD_FCARD_PRESENT)) {
774 cmd->error = MMC_ERR_TIMEOUT;
780 * The hardware is so delightfully stupid that it has a list
781 * of "data" commands. If a command isn't on this list, it'll
782 * just go back to the idle state and won't send any data
785 switch (cmd->opcode) {
799 /* ACMDs. We don't keep track of state, so we just treat them
800 * like any other command. */
805 #ifdef CONFIG_MMC_DEBUG
806 printk(KERN_WARNING "%s: Data command %d is not "
807 "supported by this controller.\n",
808 mmc_hostname(host->mmc), cmd->opcode);
810 cmd->error = MMC_ERR_INVALID;
817 * Does the request include data?
820 wbsd_prepare_data(host, cmd->data);
822 if (cmd->data->error != MMC_ERR_NONE)
826 wbsd_send_command(host, cmd);
829 * If this is a data transfer the request
830 * will be finished after the data has
833 if (cmd->data && (cmd->error == MMC_ERR_NONE)) {
835 * Dirty fix for hardware bug.
838 tasklet_schedule(&host->fifo_tasklet);
840 spin_unlock_bh(&host->lock);
846 wbsd_request_end(host, mrq);
848 spin_unlock_bh(&host->lock);
851 static void wbsd_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
853 struct wbsd_host *host = mmc_priv(mmc);
856 spin_lock_bh(&host->lock);
859 * Reset the chip on each power off.
860 * Should clear out any weird states.
862 if (ios->power_mode == MMC_POWER_OFF)
863 wbsd_init_device(host);
865 if (ios->clock >= 24000000)
867 else if (ios->clock >= 16000000)
869 else if (ios->clock >= 12000000)
875 * Only write to the clock register when
876 * there is an actual change.
878 if (clk != host->clk) {
879 wbsd_write_index(host, WBSD_IDX_CLK, clk);
886 if (ios->power_mode != MMC_POWER_OFF) {
887 pwr = inb(host->base + WBSD_CSR);
888 pwr &= ~WBSD_POWER_N;
889 outb(pwr, host->base + WBSD_CSR);
893 * MMC cards need to have pin 1 high during init.
894 * It wreaks havoc with the card detection though so
895 * that needs to be disabled.
897 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
898 if (ios->chip_select == MMC_CS_HIGH) {
899 BUG_ON(ios->bus_width != MMC_BUS_WIDTH_1);
900 setup |= WBSD_DAT3_H;
901 host->flags |= WBSD_FIGNORE_DETECT;
903 if (setup & WBSD_DAT3_H) {
904 setup &= ~WBSD_DAT3_H;
907 * We cannot resume card detection immediatly
908 * because of capacitance and delays in the chip.
910 mod_timer(&host->ignore_timer, jiffies + HZ / 100);
913 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
916 * Store bus width for later. Will be used when
917 * setting up the data transfer.
919 host->bus_width = ios->bus_width;
921 spin_unlock_bh(&host->lock);
924 static int wbsd_get_ro(struct mmc_host *mmc)
926 struct wbsd_host *host = mmc_priv(mmc);
929 spin_lock_bh(&host->lock);
931 csr = inb(host->base + WBSD_CSR);
933 outb(csr, host->base + WBSD_CSR);
937 csr = inb(host->base + WBSD_CSR);
939 outb(csr, host->base + WBSD_CSR);
941 spin_unlock_bh(&host->lock);
943 return csr & WBSD_WRPT;
946 static const struct mmc_host_ops wbsd_ops = {
947 .request = wbsd_request,
948 .set_ios = wbsd_set_ios,
949 .get_ro = wbsd_get_ro,
952 /*****************************************************************************\
954 * Interrupt handling *
956 \*****************************************************************************/
959 * Helper function to reset detection ignore
962 static void wbsd_reset_ignore(unsigned long data)
964 struct wbsd_host *host = (struct wbsd_host *)data;
966 BUG_ON(host == NULL);
968 DBG("Resetting card detection ignore\n");
970 spin_lock_bh(&host->lock);
972 host->flags &= ~WBSD_FIGNORE_DETECT;
975 * Card status might have changed during the
978 tasklet_schedule(&host->card_tasklet);
980 spin_unlock_bh(&host->lock);
987 static inline struct mmc_data *wbsd_get_data(struct wbsd_host *host)
993 WARN_ON(!host->mrq->cmd);
997 WARN_ON(!host->mrq->cmd->data);
998 if (!host->mrq->cmd->data)
1001 return host->mrq->cmd->data;
1004 static void wbsd_tasklet_card(unsigned long param)
1006 struct wbsd_host *host = (struct wbsd_host *)param;
1010 spin_lock(&host->lock);
1012 if (host->flags & WBSD_FIGNORE_DETECT) {
1013 spin_unlock(&host->lock);
1017 csr = inb(host->base + WBSD_CSR);
1018 WARN_ON(csr == 0xff);
1020 if (csr & WBSD_CARDPRESENT) {
1021 if (!(host->flags & WBSD_FCARD_PRESENT)) {
1022 DBG("Card inserted\n");
1023 host->flags |= WBSD_FCARD_PRESENT;
1027 } else if (host->flags & WBSD_FCARD_PRESENT) {
1028 DBG("Card removed\n");
1029 host->flags &= ~WBSD_FCARD_PRESENT;
1032 printk(KERN_ERR "%s: Card removed during transfer!\n",
1033 mmc_hostname(host->mmc));
1036 host->mrq->cmd->error = MMC_ERR_FAILED;
1037 tasklet_schedule(&host->finish_tasklet);
1044 * Unlock first since we might get a call back.
1047 spin_unlock(&host->lock);
1050 mmc_detect_change(host->mmc, msecs_to_jiffies(delay));
1053 static void wbsd_tasklet_fifo(unsigned long param)
1055 struct wbsd_host *host = (struct wbsd_host *)param;
1056 struct mmc_data *data;
1058 spin_lock(&host->lock);
1063 data = wbsd_get_data(host);
1067 if (data->flags & MMC_DATA_WRITE)
1068 wbsd_fill_fifo(host);
1070 wbsd_empty_fifo(host);
1075 if (host->num_sg == 0) {
1076 wbsd_write_index(host, WBSD_IDX_FIFOEN, 0);
1077 tasklet_schedule(&host->finish_tasklet);
1081 spin_unlock(&host->lock);
1084 static void wbsd_tasklet_crc(unsigned long param)
1086 struct wbsd_host *host = (struct wbsd_host *)param;
1087 struct mmc_data *data;
1089 spin_lock(&host->lock);
1094 data = wbsd_get_data(host);
1098 DBGF("CRC error\n");
1100 data->error = MMC_ERR_BADCRC;
1102 tasklet_schedule(&host->finish_tasklet);
1105 spin_unlock(&host->lock);
1108 static void wbsd_tasklet_timeout(unsigned long param)
1110 struct wbsd_host *host = (struct wbsd_host *)param;
1111 struct mmc_data *data;
1113 spin_lock(&host->lock);
1118 data = wbsd_get_data(host);
1124 data->error = MMC_ERR_TIMEOUT;
1126 tasklet_schedule(&host->finish_tasklet);
1129 spin_unlock(&host->lock);
1132 static void wbsd_tasklet_finish(unsigned long param)
1134 struct wbsd_host *host = (struct wbsd_host *)param;
1135 struct mmc_data *data;
1137 spin_lock(&host->lock);
1139 WARN_ON(!host->mrq);
1143 data = wbsd_get_data(host);
1147 wbsd_finish_data(host, data);
1150 spin_unlock(&host->lock);
1154 * Interrupt handling
1157 static irqreturn_t wbsd_irq(int irq, void *dev_id)
1159 struct wbsd_host *host = dev_id;
1162 isr = inb(host->base + WBSD_ISR);
1165 * Was it actually our hardware that caused the interrupt?
1167 if (isr == 0xff || isr == 0x00)
1173 * Schedule tasklets as needed.
1175 if (isr & WBSD_INT_CARD)
1176 tasklet_schedule(&host->card_tasklet);
1177 if (isr & WBSD_INT_FIFO_THRE)
1178 tasklet_schedule(&host->fifo_tasklet);
1179 if (isr & WBSD_INT_CRC)
1180 tasklet_hi_schedule(&host->crc_tasklet);
1181 if (isr & WBSD_INT_TIMEOUT)
1182 tasklet_hi_schedule(&host->timeout_tasklet);
1183 if (isr & WBSD_INT_TC)
1184 tasklet_schedule(&host->finish_tasklet);
1189 /*****************************************************************************\
1191 * Device initialisation and shutdown *
1193 \*****************************************************************************/
1196 * Allocate/free MMC structure.
1199 static int __devinit wbsd_alloc_mmc(struct device *dev)
1201 struct mmc_host *mmc;
1202 struct wbsd_host *host;
1205 * Allocate MMC structure.
1207 mmc = mmc_alloc_host(sizeof(struct wbsd_host), dev);
1211 host = mmc_priv(mmc);
1217 * Set host parameters.
1219 mmc->ops = &wbsd_ops;
1220 mmc->f_min = 375000;
1221 mmc->f_max = 24000000;
1222 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
1223 mmc->caps = MMC_CAP_4_BIT_DATA | MMC_CAP_MULTIWRITE | MMC_CAP_BYTEBLOCK;
1225 spin_lock_init(&host->lock);
1230 init_timer(&host->ignore_timer);
1231 host->ignore_timer.data = (unsigned long)host;
1232 host->ignore_timer.function = wbsd_reset_ignore;
1235 * Maximum number of segments. Worst case is one sector per segment
1236 * so this will be 64kB/512.
1238 mmc->max_hw_segs = 128;
1239 mmc->max_phys_segs = 128;
1242 * Maximum request size. Also limited by 64KiB buffer.
1244 mmc->max_req_size = 65536;
1247 * Maximum segment size. Could be one segment with the maximum number
1250 mmc->max_seg_size = mmc->max_req_size;
1253 * Maximum block size. We have 12 bits (= 4095) but have to subtract
1254 * space for CRC. So the maximum is 4095 - 4*2 = 4087.
1256 mmc->max_blk_size = 4087;
1259 * Maximum block count. There is no real limit so the maximum
1260 * request size will be the only restriction.
1262 mmc->max_blk_count = mmc->max_req_size;
1264 dev_set_drvdata(dev, mmc);
1269 static void wbsd_free_mmc(struct device *dev)
1271 struct mmc_host *mmc;
1272 struct wbsd_host *host;
1274 mmc = dev_get_drvdata(dev);
1278 host = mmc_priv(mmc);
1279 BUG_ON(host == NULL);
1281 del_timer_sync(&host->ignore_timer);
1285 dev_set_drvdata(dev, NULL);
1289 * Scan for known chip id:s
1292 static int __devinit wbsd_scan(struct wbsd_host *host)
1298 * Iterate through all ports, all codes to
1299 * find hardware that is in our known list.
1301 for (i = 0; i < ARRAY_SIZE(config_ports); i++) {
1302 if (!request_region(config_ports[i], 2, DRIVER_NAME))
1305 for (j = 0; j < ARRAY_SIZE(unlock_codes); j++) {
1308 host->config = config_ports[i];
1309 host->unlock_code = unlock_codes[j];
1311 wbsd_unlock_config(host);
1313 outb(WBSD_CONF_ID_HI, config_ports[i]);
1314 id = inb(config_ports[i] + 1) << 8;
1316 outb(WBSD_CONF_ID_LO, config_ports[i]);
1317 id |= inb(config_ports[i] + 1);
1319 wbsd_lock_config(host);
1321 for (k = 0; k < ARRAY_SIZE(valid_ids); k++) {
1322 if (id == valid_ids[k]) {
1330 DBG("Unknown hardware (id %x) found at %x\n",
1331 id, config_ports[i]);
1335 release_region(config_ports[i], 2);
1339 host->unlock_code = 0;
1345 * Allocate/free io port ranges
1348 static int __devinit wbsd_request_region(struct wbsd_host *host, int base)
1353 if (!request_region(base, 8, DRIVER_NAME))
1361 static void wbsd_release_regions(struct wbsd_host *host)
1364 release_region(host->base, 8);
1369 release_region(host->config, 2);
1375 * Allocate/free DMA port and buffer
1378 static void __devinit wbsd_request_dma(struct wbsd_host *host, int dma)
1383 if (request_dma(dma, DRIVER_NAME))
1387 * We need to allocate a special buffer in
1388 * order for ISA to be able to DMA to it.
1390 host->dma_buffer = kmalloc(WBSD_DMA_SIZE,
1391 GFP_NOIO | GFP_DMA | __GFP_REPEAT | __GFP_NOWARN);
1392 if (!host->dma_buffer)
1396 * Translate the address to a physical address.
1398 host->dma_addr = dma_map_single(mmc_dev(host->mmc), host->dma_buffer,
1399 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1402 * ISA DMA must be aligned on a 64k basis.
1404 if ((host->dma_addr & 0xffff) != 0)
1407 * ISA cannot access memory above 16 MB.
1409 else if (host->dma_addr >= 0x1000000)
1418 * If we've gotten here then there is some kind of alignment bug
1422 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1423 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1424 host->dma_addr = (dma_addr_t)NULL;
1426 kfree(host->dma_buffer);
1427 host->dma_buffer = NULL;
1433 printk(KERN_WARNING DRIVER_NAME ": Unable to allocate DMA %d. "
1434 "Falling back on FIFO.\n", dma);
1437 static void wbsd_release_dma(struct wbsd_host *host)
1439 if (host->dma_addr) {
1440 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1441 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1443 kfree(host->dma_buffer);
1445 free_dma(host->dma);
1448 host->dma_buffer = NULL;
1449 host->dma_addr = (dma_addr_t)NULL;
1453 * Allocate/free IRQ.
1456 static int __devinit wbsd_request_irq(struct wbsd_host *host, int irq)
1461 * Allocate interrupt.
1464 ret = request_irq(irq, wbsd_irq, IRQF_SHARED, DRIVER_NAME, host);
1473 tasklet_init(&host->card_tasklet, wbsd_tasklet_card,
1474 (unsigned long)host);
1475 tasklet_init(&host->fifo_tasklet, wbsd_tasklet_fifo,
1476 (unsigned long)host);
1477 tasklet_init(&host->crc_tasklet, wbsd_tasklet_crc,
1478 (unsigned long)host);
1479 tasklet_init(&host->timeout_tasklet, wbsd_tasklet_timeout,
1480 (unsigned long)host);
1481 tasklet_init(&host->finish_tasklet, wbsd_tasklet_finish,
1482 (unsigned long)host);
1487 static void wbsd_release_irq(struct wbsd_host *host)
1492 free_irq(host->irq, host);
1496 tasklet_kill(&host->card_tasklet);
1497 tasklet_kill(&host->fifo_tasklet);
1498 tasklet_kill(&host->crc_tasklet);
1499 tasklet_kill(&host->timeout_tasklet);
1500 tasklet_kill(&host->finish_tasklet);
1504 * Allocate all resources for the host.
1507 static int __devinit wbsd_request_resources(struct wbsd_host *host,
1508 int base, int irq, int dma)
1513 * Allocate I/O ports.
1515 ret = wbsd_request_region(host, base);
1520 * Allocate interrupt.
1522 ret = wbsd_request_irq(host, irq);
1529 wbsd_request_dma(host, dma);
1535 * Release all resources for the host.
1538 static void wbsd_release_resources(struct wbsd_host *host)
1540 wbsd_release_dma(host);
1541 wbsd_release_irq(host);
1542 wbsd_release_regions(host);
1546 * Configure the resources the chip should use.
1549 static void wbsd_chip_config(struct wbsd_host *host)
1551 wbsd_unlock_config(host);
1556 wbsd_write_config(host, WBSD_CONF_SWRST, 1);
1557 wbsd_write_config(host, WBSD_CONF_SWRST, 0);
1560 * Select SD/MMC function.
1562 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1565 * Set up card detection.
1567 wbsd_write_config(host, WBSD_CONF_PINS, WBSD_PINS_DETECT_GP11);
1572 wbsd_write_config(host, WBSD_CONF_PORT_HI, host->base >> 8);
1573 wbsd_write_config(host, WBSD_CONF_PORT_LO, host->base & 0xff);
1575 wbsd_write_config(host, WBSD_CONF_IRQ, host->irq);
1578 wbsd_write_config(host, WBSD_CONF_DRQ, host->dma);
1581 * Enable and power up chip.
1583 wbsd_write_config(host, WBSD_CONF_ENABLE, 1);
1584 wbsd_write_config(host, WBSD_CONF_POWER, 0x20);
1586 wbsd_lock_config(host);
1590 * Check that configured resources are correct.
1593 static int wbsd_chip_validate(struct wbsd_host *host)
1597 wbsd_unlock_config(host);
1600 * Select SD/MMC function.
1602 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1605 * Read configuration.
1607 base = wbsd_read_config(host, WBSD_CONF_PORT_HI) << 8;
1608 base |= wbsd_read_config(host, WBSD_CONF_PORT_LO);
1610 irq = wbsd_read_config(host, WBSD_CONF_IRQ);
1612 dma = wbsd_read_config(host, WBSD_CONF_DRQ);
1614 wbsd_lock_config(host);
1617 * Validate against given configuration.
1619 if (base != host->base)
1621 if (irq != host->irq)
1623 if ((dma != host->dma) && (host->dma != -1))
1630 * Powers down the SD function
1633 static void wbsd_chip_poweroff(struct wbsd_host *host)
1635 wbsd_unlock_config(host);
1637 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1638 wbsd_write_config(host, WBSD_CONF_ENABLE, 0);
1640 wbsd_lock_config(host);
1643 /*****************************************************************************\
1645 * Devices setup and shutdown *
1647 \*****************************************************************************/
1649 static int __devinit wbsd_init(struct device *dev, int base, int irq, int dma,
1652 struct wbsd_host *host = NULL;
1653 struct mmc_host *mmc = NULL;
1656 ret = wbsd_alloc_mmc(dev);
1660 mmc = dev_get_drvdata(dev);
1661 host = mmc_priv(mmc);
1664 * Scan for hardware.
1666 ret = wbsd_scan(host);
1668 if (pnp && (ret == -ENODEV)) {
1669 printk(KERN_WARNING DRIVER_NAME
1670 ": Unable to confirm device presence. You may "
1671 "experience lock-ups.\n");
1679 * Request resources.
1681 ret = wbsd_request_resources(host, base, irq, dma);
1683 wbsd_release_resources(host);
1689 * See if chip needs to be configured.
1692 if ((host->config != 0) && !wbsd_chip_validate(host)) {
1693 printk(KERN_WARNING DRIVER_NAME
1694 ": PnP active but chip not configured! "
1695 "You probably have a buggy BIOS. "
1696 "Configuring chip manually.\n");
1697 wbsd_chip_config(host);
1700 wbsd_chip_config(host);
1703 * Power Management stuff. No idea how this works.
1708 wbsd_unlock_config(host);
1709 wbsd_write_config(host, WBSD_CONF_PME, 0xA0);
1710 wbsd_lock_config(host);
1714 * Allow device to initialise itself properly.
1719 * Reset the chip into a known state.
1721 wbsd_init_device(host);
1725 printk(KERN_INFO "%s: W83L51xD", mmc_hostname(mmc));
1726 if (host->chip_id != 0)
1727 printk(" id %x", (int)host->chip_id);
1728 printk(" at 0x%x irq %d", (int)host->base, (int)host->irq);
1730 printk(" dma %d", (int)host->dma);
1740 static void __devexit wbsd_shutdown(struct device *dev, int pnp)
1742 struct mmc_host *mmc = dev_get_drvdata(dev);
1743 struct wbsd_host *host;
1748 host = mmc_priv(mmc);
1750 mmc_remove_host(mmc);
1753 * Power down the SD/MMC function.
1756 wbsd_chip_poweroff(host);
1758 wbsd_release_resources(host);
1767 static int __devinit wbsd_probe(struct platform_device *dev)
1769 /* Use the module parameters for resources */
1770 return wbsd_init(&dev->dev, io, irq, dma, 0);
1773 static int __devexit wbsd_remove(struct platform_device *dev)
1775 wbsd_shutdown(&dev->dev, 0);
1786 static int __devinit
1787 wbsd_pnp_probe(struct pnp_dev *pnpdev, const struct pnp_device_id *dev_id)
1792 * Get resources from PnP layer.
1794 io = pnp_port_start(pnpdev, 0);
1795 irq = pnp_irq(pnpdev, 0);
1796 if (pnp_dma_valid(pnpdev, 0))
1797 dma = pnp_dma(pnpdev, 0);
1801 DBGF("PnP resources: port %3x irq %d dma %d\n", io, irq, dma);
1803 return wbsd_init(&pnpdev->dev, io, irq, dma, 1);
1806 static void __devexit wbsd_pnp_remove(struct pnp_dev *dev)
1808 wbsd_shutdown(&dev->dev, 1);
1811 #endif /* CONFIG_PNP */
1819 static int wbsd_suspend(struct wbsd_host *host, pm_message_t state)
1821 BUG_ON(host == NULL);
1823 return mmc_suspend_host(host->mmc, state);
1826 static int wbsd_resume(struct wbsd_host *host)
1828 BUG_ON(host == NULL);
1830 wbsd_init_device(host);
1832 return mmc_resume_host(host->mmc);
1835 static int wbsd_platform_suspend(struct platform_device *dev,
1838 struct mmc_host *mmc = platform_get_drvdata(dev);
1839 struct wbsd_host *host;
1845 DBGF("Suspending...\n");
1847 host = mmc_priv(mmc);
1849 ret = wbsd_suspend(host, state);
1853 wbsd_chip_poweroff(host);
1858 static int wbsd_platform_resume(struct platform_device *dev)
1860 struct mmc_host *mmc = platform_get_drvdata(dev);
1861 struct wbsd_host *host;
1866 DBGF("Resuming...\n");
1868 host = mmc_priv(mmc);
1870 wbsd_chip_config(host);
1873 * Allow device to initialise itself properly.
1877 return wbsd_resume(host);
1882 static int wbsd_pnp_suspend(struct pnp_dev *pnp_dev, pm_message_t state)
1884 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1885 struct wbsd_host *host;
1890 DBGF("Suspending...\n");
1892 host = mmc_priv(mmc);
1894 return wbsd_suspend(host, state);
1897 static int wbsd_pnp_resume(struct pnp_dev *pnp_dev)
1899 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1900 struct wbsd_host *host;
1905 DBGF("Resuming...\n");
1907 host = mmc_priv(mmc);
1910 * See if chip needs to be configured.
1912 if (host->config != 0) {
1913 if (!wbsd_chip_validate(host)) {
1914 printk(KERN_WARNING DRIVER_NAME
1915 ": PnP active but chip not configured! "
1916 "You probably have a buggy BIOS. "
1917 "Configuring chip manually.\n");
1918 wbsd_chip_config(host);
1923 * Allow device to initialise itself properly.
1927 return wbsd_resume(host);
1930 #endif /* CONFIG_PNP */
1932 #else /* CONFIG_PM */
1934 #define wbsd_platform_suspend NULL
1935 #define wbsd_platform_resume NULL
1937 #define wbsd_pnp_suspend NULL
1938 #define wbsd_pnp_resume NULL
1940 #endif /* CONFIG_PM */
1942 static struct platform_device *wbsd_device;
1944 static struct platform_driver wbsd_driver = {
1945 .probe = wbsd_probe,
1946 .remove = __devexit_p(wbsd_remove),
1948 .suspend = wbsd_platform_suspend,
1949 .resume = wbsd_platform_resume,
1951 .name = DRIVER_NAME,
1957 static struct pnp_driver wbsd_pnp_driver = {
1958 .name = DRIVER_NAME,
1959 .id_table = pnp_dev_table,
1960 .probe = wbsd_pnp_probe,
1961 .remove = __devexit_p(wbsd_pnp_remove),
1963 .suspend = wbsd_pnp_suspend,
1964 .resume = wbsd_pnp_resume,
1967 #endif /* CONFIG_PNP */
1970 * Module loading/unloading
1973 static int __init wbsd_drv_init(void)
1977 printk(KERN_INFO DRIVER_NAME
1978 ": Winbond W83L51xD SD/MMC card interface driver\n");
1979 printk(KERN_INFO DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1984 result = pnp_register_driver(&wbsd_pnp_driver);
1988 #endif /* CONFIG_PNP */
1991 result = platform_driver_register(&wbsd_driver);
1995 wbsd_device = platform_device_alloc(DRIVER_NAME, -1);
1997 platform_driver_unregister(&wbsd_driver);
2001 result = platform_device_add(wbsd_device);
2003 platform_device_put(wbsd_device);
2004 platform_driver_unregister(&wbsd_driver);
2012 static void __exit wbsd_drv_exit(void)
2017 pnp_unregister_driver(&wbsd_pnp_driver);
2019 #endif /* CONFIG_PNP */
2022 platform_device_unregister(wbsd_device);
2024 platform_driver_unregister(&wbsd_driver);
2030 module_init(wbsd_drv_init);
2031 module_exit(wbsd_drv_exit);
2033 module_param(nopnp, uint, 0444);
2035 module_param(io, uint, 0444);
2036 module_param(irq, uint, 0444);
2037 module_param(dma, int, 0444);
2039 MODULE_LICENSE("GPL");
2040 MODULE_AUTHOR("Pierre Ossman <drzeus@drzeus.cx>");
2041 MODULE_DESCRIPTION("Winbond W83L51xD SD/MMC card interface driver");
2044 MODULE_PARM_DESC(nopnp, "Scan for device instead of relying on PNP. (default 0)");
2046 MODULE_PARM_DESC(io, "I/O base to allocate. Must be 8 byte aligned. (default 0x248)");
2047 MODULE_PARM_DESC(irq, "IRQ to allocate. (default 6)");
2048 MODULE_PARM_DESC(dma, "DMA channel to allocate. -1 for no DMA. (default 2)");