1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * linux/drivers/mmc/host/wbsd.c - Winbond W83L51xD SD/MMC driver
5 * Copyright (C) 2004-2007 Pierre Ossman, All Rights Reserved.
9 * Changes to the FIFO system should be done with extreme care since
10 * the hardware is full of bugs related to the FIFO. Known issues are:
12 * - FIFO size field in FSR is always zero.
14 * - FIFO interrupts tend not to work as they should. Interrupts are
15 * triggered only for full/empty events, not for threshold values.
17 * - On APIC systems the FIFO empty interrupt is sometimes lost.
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/init.h>
23 #include <linux/ioport.h>
24 #include <linux/platform_device.h>
25 #include <linux/interrupt.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/delay.h>
28 #include <linux/pnp.h>
29 #include <linux/highmem.h>
30 #include <linux/mmc/host.h>
31 #include <linux/mmc/mmc.h>
32 #include <linux/mmc/sd.h>
33 #include <linux/scatterlist.h>
34 #include <linux/slab.h>
41 #define DRIVER_NAME "wbsd"
44 pr_debug(DRIVER_NAME ": " x)
45 #define DBGF(f, x...) \
46 pr_debug(DRIVER_NAME " [%s()]: " f, __func__ , ##x)
54 static const struct pnp_device_id pnp_dev_table[] = {
60 MODULE_DEVICE_TABLE(pnp, pnp_dev_table);
62 #endif /* CONFIG_PNP */
64 static const int config_ports[] = { 0x2E, 0x4E };
65 static const int unlock_codes[] = { 0x83, 0x87 };
67 static const int valid_ids[] = {
72 static unsigned int param_nopnp = 0;
74 static const unsigned int param_nopnp = 1;
76 static unsigned int param_io = 0x248;
77 static unsigned int param_irq = 6;
78 static int param_dma = 2;
84 static inline void wbsd_unlock_config(struct wbsd_host *host)
86 BUG_ON(host->config == 0);
88 outb(host->unlock_code, host->config);
89 outb(host->unlock_code, host->config);
92 static inline void wbsd_lock_config(struct wbsd_host *host)
94 BUG_ON(host->config == 0);
96 outb(LOCK_CODE, host->config);
99 static inline void wbsd_write_config(struct wbsd_host *host, u8 reg, u8 value)
101 BUG_ON(host->config == 0);
103 outb(reg, host->config);
104 outb(value, host->config + 1);
107 static inline u8 wbsd_read_config(struct wbsd_host *host, u8 reg)
109 BUG_ON(host->config == 0);
111 outb(reg, host->config);
112 return inb(host->config + 1);
115 static inline void wbsd_write_index(struct wbsd_host *host, u8 index, u8 value)
117 outb(index, host->base + WBSD_IDXR);
118 outb(value, host->base + WBSD_DATAR);
121 static inline u8 wbsd_read_index(struct wbsd_host *host, u8 index)
123 outb(index, host->base + WBSD_IDXR);
124 return inb(host->base + WBSD_DATAR);
131 static void wbsd_init_device(struct wbsd_host *host)
136 * Reset chip (SD/MMC part) and fifo.
138 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
139 setup |= WBSD_FIFO_RESET | WBSD_SOFT_RESET;
140 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
145 setup &= ~WBSD_DAT3_H;
146 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
147 host->flags &= ~WBSD_FIGNORE_DETECT;
150 * Read back default clock.
152 host->clk = wbsd_read_index(host, WBSD_IDX_CLK);
157 outb(WBSD_POWER_N, host->base + WBSD_CSR);
160 * Set maximum timeout.
162 wbsd_write_index(host, WBSD_IDX_TAAC, 0x7F);
165 * Test for card presence
167 if (inb(host->base + WBSD_CSR) & WBSD_CARDPRESENT)
168 host->flags |= WBSD_FCARD_PRESENT;
170 host->flags &= ~WBSD_FCARD_PRESENT;
173 * Enable interesting interrupts.
176 ier |= WBSD_EINT_CARD;
177 ier |= WBSD_EINT_FIFO_THRE;
178 ier |= WBSD_EINT_CRC;
179 ier |= WBSD_EINT_TIMEOUT;
182 outb(ier, host->base + WBSD_EIR);
187 inb(host->base + WBSD_ISR);
190 static void wbsd_reset(struct wbsd_host *host)
194 pr_err("%s: Resetting chip\n", mmc_hostname(host->mmc));
197 * Soft reset of chip (SD/MMC part).
199 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
200 setup |= WBSD_SOFT_RESET;
201 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
204 static void wbsd_request_end(struct wbsd_host *host, struct mmc_request *mrq)
206 unsigned long dmaflags;
208 if (host->dma >= 0) {
210 * Release ISA DMA controller.
212 dmaflags = claim_dma_lock();
213 disable_dma(host->dma);
214 clear_dma_ff(host->dma);
215 release_dma_lock(dmaflags);
218 * Disable DMA on host.
220 wbsd_write_index(host, WBSD_IDX_DMA, 0);
226 * MMC layer might call back into the driver so first unlock.
228 spin_unlock(&host->lock);
229 mmc_request_done(host->mmc, mrq);
230 spin_lock(&host->lock);
234 * Scatter/gather functions
237 static inline void wbsd_init_sg(struct wbsd_host *host, struct mmc_data *data)
240 * Get info. about SG list from data structure.
242 host->cur_sg = data->sg;
243 host->num_sg = data->sg_len;
246 host->remain = host->cur_sg->length;
249 static inline int wbsd_next_sg(struct wbsd_host *host)
252 * Skip to next SG entry.
260 if (host->num_sg > 0) {
262 host->remain = host->cur_sg->length;
268 static inline char *wbsd_map_sg(struct wbsd_host *host)
270 return kmap_local_page(sg_page(host->cur_sg)) + host->cur_sg->offset;
273 static inline void wbsd_sg_to_dma(struct wbsd_host *host, struct mmc_data *data)
278 for (i = 0; i < data->sg_len; i++)
279 len += data->sg[i].length;
280 sg_copy_to_buffer(data->sg, data->sg_len, host->dma_buffer, len);
283 static inline void wbsd_dma_to_sg(struct wbsd_host *host, struct mmc_data *data)
288 for (i = 0; i < data->sg_len; i++)
289 len += data->sg[i].length;
290 sg_copy_from_buffer(data->sg, data->sg_len, host->dma_buffer, len);
297 static inline void wbsd_get_short_reply(struct wbsd_host *host,
298 struct mmc_command *cmd)
301 * Correct response type?
303 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_SHORT) {
304 cmd->error = -EILSEQ;
308 cmd->resp[0] = wbsd_read_index(host, WBSD_IDX_RESP12) << 24;
309 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP13) << 16;
310 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP14) << 8;
311 cmd->resp[0] |= wbsd_read_index(host, WBSD_IDX_RESP15) << 0;
312 cmd->resp[1] = wbsd_read_index(host, WBSD_IDX_RESP16) << 24;
315 static inline void wbsd_get_long_reply(struct wbsd_host *host,
316 struct mmc_command *cmd)
321 * Correct response type?
323 if (wbsd_read_index(host, WBSD_IDX_RSPLEN) != WBSD_RSP_LONG) {
324 cmd->error = -EILSEQ;
328 for (i = 0; i < 4; i++) {
330 wbsd_read_index(host, WBSD_IDX_RESP1 + i * 4) << 24;
332 wbsd_read_index(host, WBSD_IDX_RESP2 + i * 4) << 16;
334 wbsd_read_index(host, WBSD_IDX_RESP3 + i * 4) << 8;
336 wbsd_read_index(host, WBSD_IDX_RESP4 + i * 4) << 0;
340 static void wbsd_send_command(struct wbsd_host *host, struct mmc_command *cmd)
346 * Clear accumulated ISR. The interrupt routine
347 * will fill this one with events that occur during
353 * Send the command (CRC calculated by host).
355 outb(cmd->opcode, host->base + WBSD_CMDR);
356 for (i = 3; i >= 0; i--)
357 outb((cmd->arg >> (i * 8)) & 0xff, host->base + WBSD_CMDR);
362 * Wait for the request to complete.
365 status = wbsd_read_index(host, WBSD_IDX_STATUS);
366 } while (status & WBSD_CARDTRAFFIC);
369 * Do we expect a reply?
371 if (cmd->flags & MMC_RSP_PRESENT) {
378 if (isr & WBSD_INT_CARD)
379 cmd->error = -ENOMEDIUM;
381 else if (isr & WBSD_INT_TIMEOUT)
382 cmd->error = -ETIMEDOUT;
384 else if ((cmd->flags & MMC_RSP_CRC) && (isr & WBSD_INT_CRC))
385 cmd->error = -EILSEQ;
388 if (cmd->flags & MMC_RSP_136)
389 wbsd_get_long_reply(host, cmd);
391 wbsd_get_short_reply(host, cmd);
400 static void wbsd_empty_fifo(struct wbsd_host *host)
402 struct mmc_data *data = host->mrq->cmd->data;
404 int i, idx, fsr, fifo;
407 * Handle excessive data.
409 if (host->num_sg == 0)
412 buffer = wbsd_map_sg(host) + host->offset;
416 * Drain the fifo. This has a tendency to loop longer
417 * than the FIFO length (usually one block).
419 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_EMPTY)) {
421 * The size field in the FSR is broken so we have to
424 if (fsr & WBSD_FIFO_FULL)
426 else if (fsr & WBSD_FIFO_FUTHRE)
431 for (i = 0; i < fifo; i++) {
432 buffer[idx++] = inb(host->base + WBSD_DFR);
436 data->bytes_xfered++;
439 * End of scatter list entry?
441 if (host->remain == 0) {
442 kunmap_local(buffer);
444 * Get next entry. Check if last.
446 if (!wbsd_next_sg(host))
449 buffer = wbsd_map_sg(host);
454 kunmap_local(buffer);
457 * This is a very dirty hack to solve a
458 * hardware problem. The chip doesn't trigger
459 * FIFO threshold interrupts properly.
461 if ((data->blocks * data->blksz - data->bytes_xfered) < 16)
462 tasklet_schedule(&host->fifo_tasklet);
465 static void wbsd_fill_fifo(struct wbsd_host *host)
467 struct mmc_data *data = host->mrq->cmd->data;
469 int i, idx, fsr, fifo;
472 * Check that we aren't being called after the
473 * entire buffer has been transferred.
475 if (host->num_sg == 0)
478 buffer = wbsd_map_sg(host) + host->offset;
482 * Fill the fifo. This has a tendency to loop longer
483 * than the FIFO length (usually one block).
485 while (!((fsr = inb(host->base + WBSD_FSR)) & WBSD_FIFO_FULL)) {
487 * The size field in the FSR is broken so we have to
490 if (fsr & WBSD_FIFO_EMPTY)
492 else if (fsr & WBSD_FIFO_EMTHRE)
497 for (i = 16; i > fifo; i--) {
498 outb(buffer[idx], host->base + WBSD_DFR);
502 data->bytes_xfered++;
505 * End of scatter list entry?
507 if (host->remain == 0) {
508 kunmap_local(buffer);
510 * Get next entry. Check if last.
512 if (!wbsd_next_sg(host))
515 buffer = wbsd_map_sg(host);
520 kunmap_local(buffer);
523 * The controller stops sending interrupts for
524 * 'FIFO empty' under certain conditions. So we
525 * need to be a bit more pro-active.
527 tasklet_schedule(&host->fifo_tasklet);
530 static void wbsd_prepare_data(struct wbsd_host *host, struct mmc_data *data)
534 unsigned long dmaflags;
540 size = data->blocks * data->blksz;
543 * Check timeout values for overflow.
544 * (Yes, some cards cause this value to overflow).
546 if (data->timeout_ns > 127000000)
547 wbsd_write_index(host, WBSD_IDX_TAAC, 127);
549 wbsd_write_index(host, WBSD_IDX_TAAC,
550 data->timeout_ns / 1000000);
553 if (data->timeout_clks > 255)
554 wbsd_write_index(host, WBSD_IDX_NSAC, 255);
556 wbsd_write_index(host, WBSD_IDX_NSAC, data->timeout_clks);
559 * Inform the chip of how large blocks will be
560 * sent. It needs this to determine when to
563 * Space for CRC must be included in the size.
564 * Two bytes are needed for each data line.
566 if (host->bus_width == MMC_BUS_WIDTH_1) {
567 blksize = data->blksz + 2;
569 wbsd_write_index(host, WBSD_IDX_PBSMSB, (blksize >> 4) & 0xF0);
570 wbsd_write_index(host, WBSD_IDX_PBSLSB, blksize & 0xFF);
571 } else if (host->bus_width == MMC_BUS_WIDTH_4) {
572 blksize = data->blksz + 2 * 4;
574 wbsd_write_index(host, WBSD_IDX_PBSMSB,
575 ((blksize >> 4) & 0xF0) | WBSD_DATA_WIDTH);
576 wbsd_write_index(host, WBSD_IDX_PBSLSB, blksize & 0xFF);
578 data->error = -EINVAL;
583 * Clear the FIFO. This is needed even for DMA
584 * transfers since the chip still uses the FIFO
587 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
588 setup |= WBSD_FIFO_RESET;
589 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
594 if (host->dma >= 0) {
596 * The buffer for DMA is only 64 kB.
598 BUG_ON(size > 0x10000);
599 if (size > 0x10000) {
600 data->error = -EINVAL;
605 * Transfer data from the SG list to
608 if (data->flags & MMC_DATA_WRITE)
609 wbsd_sg_to_dma(host, data);
612 * Initialise the ISA DMA controller.
614 dmaflags = claim_dma_lock();
615 disable_dma(host->dma);
616 clear_dma_ff(host->dma);
617 if (data->flags & MMC_DATA_READ)
618 set_dma_mode(host->dma, DMA_MODE_READ & ~0x40);
620 set_dma_mode(host->dma, DMA_MODE_WRITE & ~0x40);
621 set_dma_addr(host->dma, host->dma_addr);
622 set_dma_count(host->dma, size);
624 enable_dma(host->dma);
625 release_dma_lock(dmaflags);
628 * Enable DMA on the host.
630 wbsd_write_index(host, WBSD_IDX_DMA, WBSD_DMA_ENABLE);
633 * This flag is used to keep printk
634 * output to a minimum.
639 * Initialise the SG list.
641 wbsd_init_sg(host, data);
646 wbsd_write_index(host, WBSD_IDX_DMA, 0);
649 * Set up FIFO threshold levels (and fill
650 * buffer if doing a write).
652 if (data->flags & MMC_DATA_READ) {
653 wbsd_write_index(host, WBSD_IDX_FIFOEN,
654 WBSD_FIFOEN_FULL | 8);
656 wbsd_write_index(host, WBSD_IDX_FIFOEN,
657 WBSD_FIFOEN_EMPTY | 8);
658 wbsd_fill_fifo(host);
665 static void wbsd_finish_data(struct wbsd_host *host, struct mmc_data *data)
667 unsigned long dmaflags;
671 WARN_ON(host->mrq == NULL);
674 * Send a stop command if needed.
677 wbsd_send_command(host, data->stop);
680 * Wait for the controller to leave data
684 status = wbsd_read_index(host, WBSD_IDX_STATUS);
685 } while (status & (WBSD_BLOCK_READ | WBSD_BLOCK_WRITE));
690 if (host->dma >= 0) {
692 * Disable DMA on the host.
694 wbsd_write_index(host, WBSD_IDX_DMA, 0);
697 * Turn of ISA DMA controller.
699 dmaflags = claim_dma_lock();
700 disable_dma(host->dma);
701 clear_dma_ff(host->dma);
702 count = get_dma_residue(host->dma);
703 release_dma_lock(dmaflags);
705 data->bytes_xfered = host->mrq->data->blocks *
706 host->mrq->data->blksz - count;
707 data->bytes_xfered -= data->bytes_xfered % data->blksz;
713 pr_err("%s: Incomplete DMA transfer. "
715 mmc_hostname(host->mmc), count);
721 * Transfer data from DMA buffer to
724 if (data->flags & MMC_DATA_READ)
725 wbsd_dma_to_sg(host, data);
729 if (data->bytes_xfered)
730 data->bytes_xfered -= data->blksz;
734 wbsd_request_end(host, host->mrq);
737 /*****************************************************************************\
739 * MMC layer callbacks *
741 \*****************************************************************************/
743 static void wbsd_request(struct mmc_host *mmc, struct mmc_request *mrq)
745 struct wbsd_host *host = mmc_priv(mmc);
746 struct mmc_command *cmd;
749 * Disable tasklets to avoid a deadlock.
751 spin_lock_bh(&host->lock);
753 BUG_ON(host->mrq != NULL);
760 * Check that there is actually a card in the slot.
762 if (!(host->flags & WBSD_FCARD_PRESENT)) {
763 cmd->error = -ENOMEDIUM;
769 * The hardware is so delightfully stupid that it has a list
770 * of "data" commands. If a command isn't on this list, it'll
771 * just go back to the idle state and won't send any data
774 switch (cmd->opcode) {
775 case SD_SWITCH_VOLTAGE:
776 case MMC_READ_SINGLE_BLOCK:
777 case MMC_READ_MULTIPLE_BLOCK:
778 case MMC_WRITE_DAT_UNTIL_STOP:
779 case MMC_WRITE_BLOCK:
780 case MMC_WRITE_MULTIPLE_BLOCK:
781 case MMC_PROGRAM_CID:
782 case MMC_PROGRAM_CSD:
783 case MMC_SEND_WRITE_PROT:
784 case MMC_LOCK_UNLOCK:
788 /* ACMDs. We don't keep track of state, so we just treat them
789 * like any other command. */
790 case SD_APP_SEND_SCR:
794 pr_warn("%s: Data command %d is not supported by this controller\n",
795 mmc_hostname(host->mmc), cmd->opcode);
796 cmd->error = -EINVAL;
803 * Does the request include data?
806 wbsd_prepare_data(host, cmd->data);
808 if (cmd->data->error)
812 wbsd_send_command(host, cmd);
815 * If this is a data transfer the request
816 * will be finished after the data has
819 if (cmd->data && !cmd->error) {
821 * Dirty fix for hardware bug.
824 tasklet_schedule(&host->fifo_tasklet);
826 spin_unlock_bh(&host->lock);
832 wbsd_request_end(host, mrq);
834 spin_unlock_bh(&host->lock);
837 static void wbsd_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
839 struct wbsd_host *host = mmc_priv(mmc);
842 spin_lock_bh(&host->lock);
845 * Reset the chip on each power off.
846 * Should clear out any weird states.
848 if (ios->power_mode == MMC_POWER_OFF)
849 wbsd_init_device(host);
851 if (ios->clock >= 24000000)
853 else if (ios->clock >= 16000000)
855 else if (ios->clock >= 12000000)
861 * Only write to the clock register when
862 * there is an actual change.
864 if (clk != host->clk) {
865 wbsd_write_index(host, WBSD_IDX_CLK, clk);
872 if (ios->power_mode != MMC_POWER_OFF) {
873 pwr = inb(host->base + WBSD_CSR);
874 pwr &= ~WBSD_POWER_N;
875 outb(pwr, host->base + WBSD_CSR);
879 * MMC cards need to have pin 1 high during init.
880 * It wreaks havoc with the card detection though so
881 * that needs to be disabled.
883 setup = wbsd_read_index(host, WBSD_IDX_SETUP);
884 if (ios->chip_select == MMC_CS_HIGH) {
885 BUG_ON(ios->bus_width != MMC_BUS_WIDTH_1);
886 setup |= WBSD_DAT3_H;
887 host->flags |= WBSD_FIGNORE_DETECT;
889 if (setup & WBSD_DAT3_H) {
890 setup &= ~WBSD_DAT3_H;
893 * We cannot resume card detection immediately
894 * because of capacitance and delays in the chip.
896 mod_timer(&host->ignore_timer, jiffies + HZ / 100);
899 wbsd_write_index(host, WBSD_IDX_SETUP, setup);
902 * Store bus width for later. Will be used when
903 * setting up the data transfer.
905 host->bus_width = ios->bus_width;
907 spin_unlock_bh(&host->lock);
910 static int wbsd_get_ro(struct mmc_host *mmc)
912 struct wbsd_host *host = mmc_priv(mmc);
915 spin_lock_bh(&host->lock);
917 csr = inb(host->base + WBSD_CSR);
919 outb(csr, host->base + WBSD_CSR);
923 csr = inb(host->base + WBSD_CSR);
925 outb(csr, host->base + WBSD_CSR);
927 spin_unlock_bh(&host->lock);
929 return !!(csr & WBSD_WRPT);
932 static const struct mmc_host_ops wbsd_ops = {
933 .request = wbsd_request,
934 .set_ios = wbsd_set_ios,
935 .get_ro = wbsd_get_ro,
938 /*****************************************************************************\
940 * Interrupt handling *
942 \*****************************************************************************/
945 * Helper function to reset detection ignore
948 static void wbsd_reset_ignore(struct timer_list *t)
950 struct wbsd_host *host = from_timer(host, t, ignore_timer);
952 BUG_ON(host == NULL);
954 DBG("Resetting card detection ignore\n");
956 spin_lock_bh(&host->lock);
958 host->flags &= ~WBSD_FIGNORE_DETECT;
961 * Card status might have changed during the
964 tasklet_schedule(&host->card_tasklet);
966 spin_unlock_bh(&host->lock);
973 static inline struct mmc_data *wbsd_get_data(struct wbsd_host *host)
979 WARN_ON(!host->mrq->cmd);
983 WARN_ON(!host->mrq->cmd->data);
984 if (!host->mrq->cmd->data)
987 return host->mrq->cmd->data;
990 static void wbsd_tasklet_card(struct tasklet_struct *t)
992 struct wbsd_host *host = from_tasklet(host, t, card_tasklet);
996 spin_lock(&host->lock);
998 if (host->flags & WBSD_FIGNORE_DETECT) {
999 spin_unlock(&host->lock);
1003 csr = inb(host->base + WBSD_CSR);
1004 WARN_ON(csr == 0xff);
1006 if (csr & WBSD_CARDPRESENT) {
1007 if (!(host->flags & WBSD_FCARD_PRESENT)) {
1008 DBG("Card inserted\n");
1009 host->flags |= WBSD_FCARD_PRESENT;
1013 } else if (host->flags & WBSD_FCARD_PRESENT) {
1014 DBG("Card removed\n");
1015 host->flags &= ~WBSD_FCARD_PRESENT;
1018 pr_err("%s: Card removed during transfer!\n",
1019 mmc_hostname(host->mmc));
1022 host->mrq->cmd->error = -ENOMEDIUM;
1023 tasklet_schedule(&host->finish_tasklet);
1030 * Unlock first since we might get a call back.
1033 spin_unlock(&host->lock);
1036 mmc_detect_change(host->mmc, msecs_to_jiffies(delay));
1039 static void wbsd_tasklet_fifo(struct tasklet_struct *t)
1041 struct wbsd_host *host = from_tasklet(host, t, fifo_tasklet);
1042 struct mmc_data *data;
1044 spin_lock(&host->lock);
1049 data = wbsd_get_data(host);
1053 if (data->flags & MMC_DATA_WRITE)
1054 wbsd_fill_fifo(host);
1056 wbsd_empty_fifo(host);
1061 if (host->num_sg == 0) {
1062 wbsd_write_index(host, WBSD_IDX_FIFOEN, 0);
1063 tasklet_schedule(&host->finish_tasklet);
1067 spin_unlock(&host->lock);
1070 static void wbsd_tasklet_crc(struct tasklet_struct *t)
1072 struct wbsd_host *host = from_tasklet(host, t, crc_tasklet);
1073 struct mmc_data *data;
1075 spin_lock(&host->lock);
1080 data = wbsd_get_data(host);
1084 DBGF("CRC error\n");
1086 data->error = -EILSEQ;
1088 tasklet_schedule(&host->finish_tasklet);
1091 spin_unlock(&host->lock);
1094 static void wbsd_tasklet_timeout(struct tasklet_struct *t)
1096 struct wbsd_host *host = from_tasklet(host, t, timeout_tasklet);
1097 struct mmc_data *data;
1099 spin_lock(&host->lock);
1104 data = wbsd_get_data(host);
1110 data->error = -ETIMEDOUT;
1112 tasklet_schedule(&host->finish_tasklet);
1115 spin_unlock(&host->lock);
1118 static void wbsd_tasklet_finish(struct tasklet_struct *t)
1120 struct wbsd_host *host = from_tasklet(host, t, finish_tasklet);
1121 struct mmc_data *data;
1123 spin_lock(&host->lock);
1125 WARN_ON(!host->mrq);
1129 data = wbsd_get_data(host);
1133 wbsd_finish_data(host, data);
1136 spin_unlock(&host->lock);
1140 * Interrupt handling
1143 static irqreturn_t wbsd_irq(int irq, void *dev_id)
1145 struct wbsd_host *host = dev_id;
1148 isr = inb(host->base + WBSD_ISR);
1151 * Was it actually our hardware that caused the interrupt?
1153 if (isr == 0xff || isr == 0x00)
1159 * Schedule tasklets as needed.
1161 if (isr & WBSD_INT_CARD)
1162 tasklet_schedule(&host->card_tasklet);
1163 if (isr & WBSD_INT_FIFO_THRE)
1164 tasklet_schedule(&host->fifo_tasklet);
1165 if (isr & WBSD_INT_CRC)
1166 tasklet_hi_schedule(&host->crc_tasklet);
1167 if (isr & WBSD_INT_TIMEOUT)
1168 tasklet_hi_schedule(&host->timeout_tasklet);
1169 if (isr & WBSD_INT_TC)
1170 tasklet_schedule(&host->finish_tasklet);
1175 /*****************************************************************************\
1177 * Device initialisation and shutdown *
1179 \*****************************************************************************/
1182 * Allocate/free MMC structure.
1185 static int wbsd_alloc_mmc(struct device *dev)
1187 struct mmc_host *mmc;
1188 struct wbsd_host *host;
1191 * Allocate MMC structure.
1193 mmc = mmc_alloc_host(sizeof(struct wbsd_host), dev);
1197 host = mmc_priv(mmc);
1203 * Set host parameters.
1205 mmc->ops = &wbsd_ops;
1206 mmc->f_min = 375000;
1207 mmc->f_max = 24000000;
1208 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
1209 mmc->caps = MMC_CAP_4_BIT_DATA;
1211 spin_lock_init(&host->lock);
1216 timer_setup(&host->ignore_timer, wbsd_reset_ignore, 0);
1219 * Maximum number of segments. Worst case is one sector per segment
1220 * so this will be 64kB/512.
1222 mmc->max_segs = 128;
1225 * Maximum request size. Also limited by 64KiB buffer.
1227 mmc->max_req_size = 65536;
1230 * Maximum segment size. Could be one segment with the maximum number
1233 mmc->max_seg_size = mmc->max_req_size;
1236 * Maximum block size. We have 12 bits (= 4095) but have to subtract
1237 * space for CRC. So the maximum is 4095 - 4*2 = 4087.
1239 mmc->max_blk_size = 4087;
1242 * Maximum block count. There is no real limit so the maximum
1243 * request size will be the only restriction.
1245 mmc->max_blk_count = mmc->max_req_size;
1247 dev_set_drvdata(dev, mmc);
1252 static void wbsd_free_mmc(struct device *dev)
1254 struct mmc_host *mmc;
1255 struct wbsd_host *host;
1257 mmc = dev_get_drvdata(dev);
1261 host = mmc_priv(mmc);
1262 BUG_ON(host == NULL);
1264 del_timer_sync(&host->ignore_timer);
1270 * Scan for known chip id:s
1273 static int wbsd_scan(struct wbsd_host *host)
1279 * Iterate through all ports, all codes to
1280 * find hardware that is in our known list.
1282 for (i = 0; i < ARRAY_SIZE(config_ports); i++) {
1283 if (!request_region(config_ports[i], 2, DRIVER_NAME))
1286 for (j = 0; j < ARRAY_SIZE(unlock_codes); j++) {
1289 host->config = config_ports[i];
1290 host->unlock_code = unlock_codes[j];
1292 wbsd_unlock_config(host);
1294 outb(WBSD_CONF_ID_HI, config_ports[i]);
1295 id = inb(config_ports[i] + 1) << 8;
1297 outb(WBSD_CONF_ID_LO, config_ports[i]);
1298 id |= inb(config_ports[i] + 1);
1300 wbsd_lock_config(host);
1302 for (k = 0; k < ARRAY_SIZE(valid_ids); k++) {
1303 if (id == valid_ids[k]) {
1311 DBG("Unknown hardware (id %x) found at %x\n",
1312 id, config_ports[i]);
1316 release_region(config_ports[i], 2);
1320 host->unlock_code = 0;
1326 * Allocate/free io port ranges
1329 static int wbsd_request_region(struct wbsd_host *host, int base)
1334 if (!request_region(base, 8, DRIVER_NAME))
1342 static void wbsd_release_regions(struct wbsd_host *host)
1345 release_region(host->base, 8);
1350 release_region(host->config, 2);
1356 * Allocate/free DMA port and buffer
1359 static void wbsd_request_dma(struct wbsd_host *host, int dma)
1364 if (request_dma(dma, DRIVER_NAME))
1368 * We need to allocate a special buffer in
1369 * order for ISA to be able to DMA to it.
1371 host->dma_buffer = kmalloc(WBSD_DMA_SIZE,
1372 GFP_NOIO | GFP_DMA | __GFP_RETRY_MAYFAIL | __GFP_NOWARN);
1373 if (!host->dma_buffer)
1377 * Translate the address to a physical address.
1379 host->dma_addr = dma_map_single(mmc_dev(host->mmc), host->dma_buffer,
1380 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1381 if (dma_mapping_error(mmc_dev(host->mmc), host->dma_addr))
1385 * ISA DMA must be aligned on a 64k basis.
1387 if ((host->dma_addr & 0xffff) != 0)
1390 * ISA cannot access memory above 16 MB.
1392 else if (host->dma_addr >= 0x1000000)
1401 * If we've gotten here then there is some kind of alignment bug
1405 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1406 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1410 kfree(host->dma_buffer);
1411 host->dma_buffer = NULL;
1417 pr_warn(DRIVER_NAME ": Unable to allocate DMA %d - falling back on FIFO\n",
1421 static void wbsd_release_dma(struct wbsd_host *host)
1424 * host->dma_addr is valid here iff host->dma_buffer is not NULL.
1426 if (host->dma_buffer) {
1427 dma_unmap_single(mmc_dev(host->mmc), host->dma_addr,
1428 WBSD_DMA_SIZE, DMA_BIDIRECTIONAL);
1429 kfree(host->dma_buffer);
1432 free_dma(host->dma);
1435 host->dma_buffer = NULL;
1440 * Allocate/free IRQ.
1443 static int wbsd_request_irq(struct wbsd_host *host, int irq)
1448 * Set up tasklets. Must be done before requesting interrupt.
1450 tasklet_setup(&host->card_tasklet, wbsd_tasklet_card);
1451 tasklet_setup(&host->fifo_tasklet, wbsd_tasklet_fifo);
1452 tasklet_setup(&host->crc_tasklet, wbsd_tasklet_crc);
1453 tasklet_setup(&host->timeout_tasklet, wbsd_tasklet_timeout);
1454 tasklet_setup(&host->finish_tasklet, wbsd_tasklet_finish);
1457 * Allocate interrupt.
1459 ret = request_irq(irq, wbsd_irq, IRQF_SHARED, DRIVER_NAME, host);
1468 static void wbsd_release_irq(struct wbsd_host *host)
1473 free_irq(host->irq, host);
1477 tasklet_kill(&host->card_tasklet);
1478 tasklet_kill(&host->fifo_tasklet);
1479 tasklet_kill(&host->crc_tasklet);
1480 tasklet_kill(&host->timeout_tasklet);
1481 tasklet_kill(&host->finish_tasklet);
1485 * Allocate all resources for the host.
1488 static int wbsd_request_resources(struct wbsd_host *host,
1489 int base, int irq, int dma)
1494 * Allocate I/O ports.
1496 ret = wbsd_request_region(host, base);
1501 * Allocate interrupt.
1503 ret = wbsd_request_irq(host, irq);
1510 wbsd_request_dma(host, dma);
1516 * Release all resources for the host.
1519 static void wbsd_release_resources(struct wbsd_host *host)
1521 wbsd_release_dma(host);
1522 wbsd_release_irq(host);
1523 wbsd_release_regions(host);
1527 * Configure the resources the chip should use.
1530 static void wbsd_chip_config(struct wbsd_host *host)
1532 wbsd_unlock_config(host);
1537 wbsd_write_config(host, WBSD_CONF_SWRST, 1);
1538 wbsd_write_config(host, WBSD_CONF_SWRST, 0);
1541 * Select SD/MMC function.
1543 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1546 * Set up card detection.
1548 wbsd_write_config(host, WBSD_CONF_PINS, WBSD_PINS_DETECT_GP11);
1553 wbsd_write_config(host, WBSD_CONF_PORT_HI, host->base >> 8);
1554 wbsd_write_config(host, WBSD_CONF_PORT_LO, host->base & 0xff);
1556 wbsd_write_config(host, WBSD_CONF_IRQ, host->irq);
1559 wbsd_write_config(host, WBSD_CONF_DRQ, host->dma);
1562 * Enable and power up chip.
1564 wbsd_write_config(host, WBSD_CONF_ENABLE, 1);
1565 wbsd_write_config(host, WBSD_CONF_POWER, 0x20);
1567 wbsd_lock_config(host);
1571 * Check that configured resources are correct.
1574 static int wbsd_chip_validate(struct wbsd_host *host)
1578 wbsd_unlock_config(host);
1581 * Select SD/MMC function.
1583 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1586 * Read configuration.
1588 base = wbsd_read_config(host, WBSD_CONF_PORT_HI) << 8;
1589 base |= wbsd_read_config(host, WBSD_CONF_PORT_LO);
1591 irq = wbsd_read_config(host, WBSD_CONF_IRQ);
1593 dma = wbsd_read_config(host, WBSD_CONF_DRQ);
1595 wbsd_lock_config(host);
1598 * Validate against given configuration.
1600 if (base != host->base)
1602 if (irq != host->irq)
1604 if ((dma != host->dma) && (host->dma != -1))
1611 * Powers down the SD function
1614 static void wbsd_chip_poweroff(struct wbsd_host *host)
1616 wbsd_unlock_config(host);
1618 wbsd_write_config(host, WBSD_CONF_DEVICE, DEVICE_SD);
1619 wbsd_write_config(host, WBSD_CONF_ENABLE, 0);
1621 wbsd_lock_config(host);
1624 /*****************************************************************************\
1626 * Devices setup and shutdown *
1628 \*****************************************************************************/
1630 static int wbsd_init(struct device *dev, int base, int irq, int dma,
1633 struct wbsd_host *host = NULL;
1634 struct mmc_host *mmc = NULL;
1637 ret = wbsd_alloc_mmc(dev);
1641 mmc = dev_get_drvdata(dev);
1642 host = mmc_priv(mmc);
1645 * Scan for hardware.
1647 ret = wbsd_scan(host);
1649 if (pnp && (ret == -ENODEV)) {
1650 pr_warn(DRIVER_NAME ": Unable to confirm device presence - you may experience lock-ups\n");
1658 * Request resources.
1660 ret = wbsd_request_resources(host, base, irq, dma);
1662 wbsd_release_resources(host);
1668 * See if chip needs to be configured.
1671 if ((host->config != 0) && !wbsd_chip_validate(host)) {
1672 pr_warn(DRIVER_NAME ": PnP active but chip not configured! You probably have a buggy BIOS. Configuring chip manually.\n");
1673 wbsd_chip_config(host);
1676 wbsd_chip_config(host);
1679 * Power Management stuff. No idea how this works.
1684 wbsd_unlock_config(host);
1685 wbsd_write_config(host, WBSD_CONF_PME, 0xA0);
1686 wbsd_lock_config(host);
1690 * Allow device to initialise itself properly.
1695 * Reset the chip into a known state.
1697 wbsd_init_device(host);
1699 ret = mmc_add_host(mmc);
1702 wbsd_chip_poweroff(host);
1704 wbsd_release_resources(host);
1709 pr_info("%s: W83L51xD", mmc_hostname(mmc));
1710 if (host->chip_id != 0)
1711 printk(" id %x", (int)host->chip_id);
1712 printk(" at 0x%x irq %d", (int)host->base, (int)host->irq);
1714 printk(" dma %d", (int)host->dma);
1724 static void wbsd_shutdown(struct device *dev, int pnp)
1726 struct mmc_host *mmc = dev_get_drvdata(dev);
1727 struct wbsd_host *host;
1732 host = mmc_priv(mmc);
1734 mmc_remove_host(mmc);
1737 * Power down the SD/MMC function.
1740 wbsd_chip_poweroff(host);
1742 wbsd_release_resources(host);
1751 static int wbsd_probe(struct platform_device *dev)
1753 /* Use the module parameters for resources */
1754 return wbsd_init(&dev->dev, param_io, param_irq, param_dma, 0);
1757 static void wbsd_remove(struct platform_device *dev)
1759 wbsd_shutdown(&dev->dev, 0);
1769 wbsd_pnp_probe(struct pnp_dev *pnpdev, const struct pnp_device_id *dev_id)
1774 * Get resources from PnP layer.
1776 io = pnp_port_start(pnpdev, 0);
1777 irq = pnp_irq(pnpdev, 0);
1778 if (pnp_dma_valid(pnpdev, 0))
1779 dma = pnp_dma(pnpdev, 0);
1783 DBGF("PnP resources: port %3x irq %d dma %d\n", io, irq, dma);
1785 return wbsd_init(&pnpdev->dev, io, irq, dma, 1);
1788 static void wbsd_pnp_remove(struct pnp_dev *dev)
1790 wbsd_shutdown(&dev->dev, 1);
1793 #endif /* CONFIG_PNP */
1801 static int wbsd_platform_suspend(struct platform_device *dev,
1804 struct mmc_host *mmc = platform_get_drvdata(dev);
1805 struct wbsd_host *host;
1810 DBGF("Suspending...\n");
1812 host = mmc_priv(mmc);
1814 wbsd_chip_poweroff(host);
1818 static int wbsd_platform_resume(struct platform_device *dev)
1820 struct mmc_host *mmc = platform_get_drvdata(dev);
1821 struct wbsd_host *host;
1826 DBGF("Resuming...\n");
1828 host = mmc_priv(mmc);
1830 wbsd_chip_config(host);
1833 * Allow device to initialise itself properly.
1837 wbsd_init_device(host);
1843 static int wbsd_pnp_suspend(struct pnp_dev *pnp_dev, pm_message_t state)
1845 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1850 DBGF("Suspending...\n");
1854 static int wbsd_pnp_resume(struct pnp_dev *pnp_dev)
1856 struct mmc_host *mmc = dev_get_drvdata(&pnp_dev->dev);
1857 struct wbsd_host *host;
1862 DBGF("Resuming...\n");
1864 host = mmc_priv(mmc);
1867 * See if chip needs to be configured.
1869 if (host->config != 0) {
1870 if (!wbsd_chip_validate(host)) {
1871 pr_warn(DRIVER_NAME ": PnP active but chip not configured! You probably have a buggy BIOS. Configuring chip manually.\n");
1872 wbsd_chip_config(host);
1877 * Allow device to initialise itself properly.
1881 wbsd_init_device(host);
1885 #endif /* CONFIG_PNP */
1887 #else /* CONFIG_PM */
1889 #define wbsd_platform_suspend NULL
1890 #define wbsd_platform_resume NULL
1892 #define wbsd_pnp_suspend NULL
1893 #define wbsd_pnp_resume NULL
1895 #endif /* CONFIG_PM */
1897 static struct platform_device *wbsd_device;
1899 static struct platform_driver wbsd_driver = {
1900 .probe = wbsd_probe,
1901 .remove_new = wbsd_remove,
1902 .suspend = wbsd_platform_suspend,
1903 .resume = wbsd_platform_resume,
1905 .name = DRIVER_NAME,
1906 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1912 static struct pnp_driver wbsd_pnp_driver = {
1913 .name = DRIVER_NAME,
1914 .id_table = pnp_dev_table,
1915 .probe = wbsd_pnp_probe,
1916 .remove = wbsd_pnp_remove,
1918 .suspend = wbsd_pnp_suspend,
1919 .resume = wbsd_pnp_resume,
1922 #endif /* CONFIG_PNP */
1925 * Module loading/unloading
1928 static int __init wbsd_drv_init(void)
1933 ": Winbond W83L51xD SD/MMC card interface driver\n");
1934 pr_info(DRIVER_NAME ": Copyright(c) Pierre Ossman\n");
1939 result = pnp_register_driver(&wbsd_pnp_driver);
1943 #endif /* CONFIG_PNP */
1946 result = platform_driver_register(&wbsd_driver);
1950 wbsd_device = platform_device_alloc(DRIVER_NAME, -1);
1952 platform_driver_unregister(&wbsd_driver);
1956 result = platform_device_add(wbsd_device);
1958 platform_device_put(wbsd_device);
1959 platform_driver_unregister(&wbsd_driver);
1967 static void __exit wbsd_drv_exit(void)
1972 pnp_unregister_driver(&wbsd_pnp_driver);
1974 #endif /* CONFIG_PNP */
1977 platform_device_unregister(wbsd_device);
1979 platform_driver_unregister(&wbsd_driver);
1985 module_init(wbsd_drv_init);
1986 module_exit(wbsd_drv_exit);
1988 module_param_hw_named(nopnp, param_nopnp, uint, other, 0444);
1990 module_param_hw_named(io, param_io, uint, ioport, 0444);
1991 module_param_hw_named(irq, param_irq, uint, irq, 0444);
1992 module_param_hw_named(dma, param_dma, int, dma, 0444);
1994 MODULE_LICENSE("GPL");
1995 MODULE_AUTHOR("Pierre Ossman <pierre@ossman.eu>");
1996 MODULE_DESCRIPTION("Winbond W83L51xD SD/MMC card interface driver");
1999 MODULE_PARM_DESC(nopnp, "Scan for device instead of relying on PNP. (default 0)");
2001 MODULE_PARM_DESC(io, "I/O base to allocate. Must be 8 byte aligned. (default 0x248)");
2002 MODULE_PARM_DESC(irq, "IRQ to allocate. (default 6)");
2003 MODULE_PARM_DESC(dma, "DMA channel to allocate. -1 for no DMA. (default 2)");