2 * linux/drivers/mmc/host/pxa.c - PXA MMCI driver
4 * Copyright (C) 2003 Russell King, All Rights Reserved.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * This hardware is really sick:
11 * - No way to clear interrupts.
12 * - Have to turn off the clock whenever we touch the device.
13 * - Doesn't tell you how many data blocks were transferred.
16 * 1 and 3 byte data transfers not supported
17 * max block length up to 1023
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/ioport.h>
22 #include <linux/platform_device.h>
23 #include <linux/delay.h>
24 #include <linux/interrupt.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/clk.h>
27 #include <linux/err.h>
28 #include <linux/mmc/host.h>
32 #include <asm/sizes.h>
34 #include <asm/arch/pxa-regs.h>
35 #include <asm/arch/mmc.h>
39 #define DRIVER_NAME "pxa2xx-mci"
42 #define CLKRT_OFF (~0)
50 unsigned long clkrate
;
56 unsigned int power_mode
;
57 struct pxamci_platform_data
*pdata
;
59 struct mmc_request
*mrq
;
60 struct mmc_command
*cmd
;
61 struct mmc_data
*data
;
64 struct pxa_dma_desc
*sg_cpu
;
70 static void pxamci_stop_clock(struct pxamci_host
*host
)
72 if (readl(host
->base
+ MMC_STAT
) & STAT_CLK_EN
) {
73 unsigned long timeout
= 10000;
76 writel(STOP_CLOCK
, host
->base
+ MMC_STRPCL
);
79 v
= readl(host
->base
+ MMC_STAT
);
80 if (!(v
& STAT_CLK_EN
))
86 dev_err(mmc_dev(host
->mmc
), "unable to stop clock\n");
90 static void pxamci_enable_irq(struct pxamci_host
*host
, unsigned int mask
)
94 spin_lock_irqsave(&host
->lock
, flags
);
96 writel(host
->imask
, host
->base
+ MMC_I_MASK
);
97 spin_unlock_irqrestore(&host
->lock
, flags
);
100 static void pxamci_disable_irq(struct pxamci_host
*host
, unsigned int mask
)
104 spin_lock_irqsave(&host
->lock
, flags
);
106 writel(host
->imask
, host
->base
+ MMC_I_MASK
);
107 spin_unlock_irqrestore(&host
->lock
, flags
);
110 static void pxamci_setup_data(struct pxamci_host
*host
, struct mmc_data
*data
)
112 unsigned int nob
= data
->blocks
;
113 unsigned long long clks
;
114 unsigned int timeout
;
120 if (data
->flags
& MMC_DATA_STREAM
)
123 writel(nob
, host
->base
+ MMC_NOB
);
124 writel(data
->blksz
, host
->base
+ MMC_BLKLEN
);
126 clks
= (unsigned long long)data
->timeout_ns
* host
->clkrate
;
127 do_div(clks
, 1000000000UL);
128 timeout
= (unsigned int)clks
+ (data
->timeout_clks
<< host
->clkrt
);
129 writel((timeout
+ 255) / 256, host
->base
+ MMC_RDTO
);
131 if (data
->flags
& MMC_DATA_READ
) {
132 host
->dma_dir
= DMA_FROM_DEVICE
;
133 dcmd
= DCMD_INCTRGADDR
| DCMD_FLOWTRG
;
135 DRCMRRXMMC
= host
->dma
| DRCMR_MAPVLD
;
137 host
->dma_dir
= DMA_TO_DEVICE
;
138 dcmd
= DCMD_INCSRCADDR
| DCMD_FLOWSRC
;
140 DRCMRTXMMC
= host
->dma
| DRCMR_MAPVLD
;
143 dcmd
|= DCMD_BURST32
| DCMD_WIDTH1
;
145 host
->dma_len
= dma_map_sg(mmc_dev(host
->mmc
), data
->sg
, data
->sg_len
,
148 for (i
= 0; i
< host
->dma_len
; i
++) {
149 unsigned int length
= sg_dma_len(&data
->sg
[i
]);
150 host
->sg_cpu
[i
].dcmd
= dcmd
| length
;
151 if (length
& 31 && !(data
->flags
& MMC_DATA_READ
))
152 host
->sg_cpu
[i
].dcmd
|= DCMD_ENDIRQEN
;
153 if (data
->flags
& MMC_DATA_READ
) {
154 host
->sg_cpu
[i
].dsadr
= host
->res
->start
+ MMC_RXFIFO
;
155 host
->sg_cpu
[i
].dtadr
= sg_dma_address(&data
->sg
[i
]);
157 host
->sg_cpu
[i
].dsadr
= sg_dma_address(&data
->sg
[i
]);
158 host
->sg_cpu
[i
].dtadr
= host
->res
->start
+ MMC_TXFIFO
;
160 host
->sg_cpu
[i
].ddadr
= host
->sg_dma
+ (i
+ 1) *
161 sizeof(struct pxa_dma_desc
);
163 host
->sg_cpu
[host
->dma_len
- 1].ddadr
= DDADR_STOP
;
166 DDADR(host
->dma
) = host
->sg_dma
;
167 DCSR(host
->dma
) = DCSR_RUN
;
170 static void pxamci_start_cmd(struct pxamci_host
*host
, struct mmc_command
*cmd
, unsigned int cmdat
)
172 WARN_ON(host
->cmd
!= NULL
);
175 if (cmd
->flags
& MMC_RSP_BUSY
)
178 #define RSP_TYPE(x) ((x) & ~(MMC_RSP_BUSY|MMC_RSP_OPCODE))
179 switch (RSP_TYPE(mmc_resp_type(cmd
))) {
180 case RSP_TYPE(MMC_RSP_R1
): /* r1, r1b, r6, r7 */
181 cmdat
|= CMDAT_RESP_SHORT
;
183 case RSP_TYPE(MMC_RSP_R3
):
184 cmdat
|= CMDAT_RESP_R3
;
186 case RSP_TYPE(MMC_RSP_R2
):
187 cmdat
|= CMDAT_RESP_R2
;
193 writel(cmd
->opcode
, host
->base
+ MMC_CMD
);
194 writel(cmd
->arg
>> 16, host
->base
+ MMC_ARGH
);
195 writel(cmd
->arg
& 0xffff, host
->base
+ MMC_ARGL
);
196 writel(cmdat
, host
->base
+ MMC_CMDAT
);
197 writel(host
->clkrt
, host
->base
+ MMC_CLKRT
);
199 writel(START_CLOCK
, host
->base
+ MMC_STRPCL
);
201 pxamci_enable_irq(host
, END_CMD_RES
);
204 static void pxamci_finish_request(struct pxamci_host
*host
, struct mmc_request
*mrq
)
209 mmc_request_done(host
->mmc
, mrq
);
212 static int pxamci_cmd_done(struct pxamci_host
*host
, unsigned int stat
)
214 struct mmc_command
*cmd
= host
->cmd
;
224 * Did I mention this is Sick. We always need to
225 * discard the upper 8 bits of the first 16-bit word.
227 v
= readl(host
->base
+ MMC_RES
) & 0xffff;
228 for (i
= 0; i
< 4; i
++) {
229 u32 w1
= readl(host
->base
+ MMC_RES
) & 0xffff;
230 u32 w2
= readl(host
->base
+ MMC_RES
) & 0xffff;
231 cmd
->resp
[i
] = v
<< 24 | w1
<< 8 | w2
>> 8;
235 if (stat
& STAT_TIME_OUT_RESPONSE
) {
236 cmd
->error
= -ETIMEDOUT
;
237 } else if (stat
& STAT_RES_CRC_ERR
&& cmd
->flags
& MMC_RSP_CRC
) {
240 * workaround for erratum #42:
241 * Intel PXA27x Family Processor Specification Update Rev 001
242 * A bogus CRC error can appear if the msb of a 136 bit
245 if (cmd
->flags
& MMC_RSP_136
&& cmd
->resp
[0] & 0x80000000) {
246 pr_debug("ignoring CRC from command %d - *risky*\n", cmd
->opcode
);
249 cmd
->error
= -EILSEQ
;
252 pxamci_disable_irq(host
, END_CMD_RES
);
253 if (host
->data
&& !cmd
->error
) {
254 pxamci_enable_irq(host
, DATA_TRAN_DONE
);
256 pxamci_finish_request(host
, host
->mrq
);
262 static int pxamci_data_done(struct pxamci_host
*host
, unsigned int stat
)
264 struct mmc_data
*data
= host
->data
;
270 dma_unmap_sg(mmc_dev(host
->mmc
), data
->sg
, host
->dma_len
,
273 if (stat
& STAT_READ_TIME_OUT
)
274 data
->error
= -ETIMEDOUT
;
275 else if (stat
& (STAT_CRC_READ_ERROR
|STAT_CRC_WRITE_ERROR
))
276 data
->error
= -EILSEQ
;
279 * There appears to be a hardware design bug here. There seems to
280 * be no way to find out how much data was transferred to the card.
281 * This means that if there was an error on any block, we mark all
282 * data blocks as being in error.
285 data
->bytes_xfered
= data
->blocks
* data
->blksz
;
287 data
->bytes_xfered
= 0;
289 pxamci_disable_irq(host
, DATA_TRAN_DONE
);
292 if (host
->mrq
->stop
) {
293 pxamci_stop_clock(host
);
294 pxamci_start_cmd(host
, host
->mrq
->stop
, host
->cmdat
);
296 pxamci_finish_request(host
, host
->mrq
);
302 static irqreturn_t
pxamci_irq(int irq
, void *devid
)
304 struct pxamci_host
*host
= devid
;
308 ireg
= readl(host
->base
+ MMC_I_REG
) & ~readl(host
->base
+ MMC_I_MASK
);
311 unsigned stat
= readl(host
->base
+ MMC_STAT
);
313 pr_debug("PXAMCI: irq %08x stat %08x\n", ireg
, stat
);
315 if (ireg
& END_CMD_RES
)
316 handled
|= pxamci_cmd_done(host
, stat
);
317 if (ireg
& DATA_TRAN_DONE
)
318 handled
|= pxamci_data_done(host
, stat
);
319 if (ireg
& SDIO_INT
) {
320 mmc_signal_sdio_irq(host
->mmc
);
325 return IRQ_RETVAL(handled
);
328 static void pxamci_request(struct mmc_host
*mmc
, struct mmc_request
*mrq
)
330 struct pxamci_host
*host
= mmc_priv(mmc
);
333 WARN_ON(host
->mrq
!= NULL
);
337 pxamci_stop_clock(host
);
340 host
->cmdat
&= ~CMDAT_INIT
;
343 pxamci_setup_data(host
, mrq
->data
);
345 cmdat
&= ~CMDAT_BUSY
;
346 cmdat
|= CMDAT_DATAEN
| CMDAT_DMAEN
;
347 if (mrq
->data
->flags
& MMC_DATA_WRITE
)
348 cmdat
|= CMDAT_WRITE
;
350 if (mrq
->data
->flags
& MMC_DATA_STREAM
)
351 cmdat
|= CMDAT_STREAM
;
354 pxamci_start_cmd(host
, mrq
->cmd
, cmdat
);
357 static int pxamci_get_ro(struct mmc_host
*mmc
)
359 struct pxamci_host
*host
= mmc_priv(mmc
);
361 if (host
->pdata
&& host
->pdata
->get_ro
)
362 return host
->pdata
->get_ro(mmc_dev(mmc
));
363 /* Host doesn't support read only detection so assume writeable */
367 static void pxamci_set_ios(struct mmc_host
*mmc
, struct mmc_ios
*ios
)
369 struct pxamci_host
*host
= mmc_priv(mmc
);
372 unsigned long rate
= host
->clkrate
;
373 unsigned int clk
= rate
/ ios
->clock
;
375 if (host
->clkrt
== CLKRT_OFF
)
376 clk_enable(host
->clk
);
379 * clk might result in a lower divisor than we
380 * desire. check for that condition and adjust
383 if (rate
/ clk
> ios
->clock
)
385 host
->clkrt
= fls(clk
) - 1;
388 * we write clkrt on the next command
391 pxamci_stop_clock(host
);
392 if (host
->clkrt
!= CLKRT_OFF
) {
393 host
->clkrt
= CLKRT_OFF
;
394 clk_disable(host
->clk
);
398 if (host
->power_mode
!= ios
->power_mode
) {
399 host
->power_mode
= ios
->power_mode
;
401 if (host
->pdata
&& host
->pdata
->setpower
)
402 host
->pdata
->setpower(mmc_dev(mmc
), ios
->vdd
);
404 if (ios
->power_mode
== MMC_POWER_ON
)
405 host
->cmdat
|= CMDAT_INIT
;
408 if (ios
->bus_width
== MMC_BUS_WIDTH_4
)
409 host
->cmdat
|= CMDAT_SD_4DAT
;
411 host
->cmdat
&= ~CMDAT_SD_4DAT
;
413 pr_debug("PXAMCI: clkrt = %x cmdat = %x\n",
414 host
->clkrt
, host
->cmdat
);
417 static void pxamci_enable_sdio_irq(struct mmc_host
*host
, int enable
)
419 struct pxamci_host
*pxa_host
= mmc_priv(host
);
422 pxamci_enable_irq(pxa_host
, SDIO_INT
);
424 pxamci_disable_irq(pxa_host
, SDIO_INT
);
427 static const struct mmc_host_ops pxamci_ops
= {
428 .request
= pxamci_request
,
429 .get_ro
= pxamci_get_ro
,
430 .set_ios
= pxamci_set_ios
,
431 .enable_sdio_irq
= pxamci_enable_sdio_irq
,
434 static void pxamci_dma_irq(int dma
, void *devid
)
436 struct pxamci_host
*host
= devid
;
437 int dcsr
= DCSR(dma
);
438 DCSR(dma
) = dcsr
& ~DCSR_STOPIRQEN
;
440 if (dcsr
& DCSR_ENDINTR
) {
441 writel(BUF_PART_FULL
, host
->base
+ MMC_PRTBUF
);
443 printk(KERN_ERR
"%s: DMA error on channel %d (DCSR=%#x)\n",
444 mmc_hostname(host
->mmc
), dma
, dcsr
);
445 host
->data
->error
= -EIO
;
446 pxamci_data_done(host
, 0);
450 static irqreturn_t
pxamci_detect_irq(int irq
, void *devid
)
452 struct pxamci_host
*host
= mmc_priv(devid
);
454 mmc_detect_change(devid
, host
->pdata
->detect_delay
);
458 static int pxamci_probe(struct platform_device
*pdev
)
460 struct mmc_host
*mmc
;
461 struct pxamci_host
*host
= NULL
;
465 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
466 irq
= platform_get_irq(pdev
, 0);
470 r
= request_mem_region(r
->start
, SZ_4K
, DRIVER_NAME
);
474 mmc
= mmc_alloc_host(sizeof(struct pxamci_host
), &pdev
->dev
);
480 mmc
->ops
= &pxamci_ops
;
483 * We can do SG-DMA, but we don't because we never know how much
484 * data we successfully wrote to the card.
486 mmc
->max_phys_segs
= NR_SG
;
489 * Our hardware DMA can handle a maximum of one page per SG entry.
491 mmc
->max_seg_size
= PAGE_SIZE
;
494 * Block length register is only 10 bits before PXA27x.
496 mmc
->max_blk_size
= (cpu_is_pxa21x() || cpu_is_pxa25x()) ? 1023 : 2048;
499 * Block count register is 16 bits.
501 mmc
->max_blk_count
= 65535;
503 host
= mmc_priv(mmc
);
506 host
->pdata
= pdev
->dev
.platform_data
;
507 host
->clkrt
= CLKRT_OFF
;
509 host
->clk
= clk_get(&pdev
->dev
, "MMCCLK");
510 if (IS_ERR(host
->clk
)) {
511 ret
= PTR_ERR(host
->clk
);
516 host
->clkrate
= clk_get_rate(host
->clk
);
519 * Calculate minimum clock rate, rounding up.
521 mmc
->f_min
= (host
->clkrate
+ 63) / 64;
522 mmc
->f_max
= host
->clkrate
;
524 mmc
->ocr_avail
= host
->pdata
?
525 host
->pdata
->ocr_mask
:
526 MMC_VDD_32_33
|MMC_VDD_33_34
;
529 if (!cpu_is_pxa21x() && !cpu_is_pxa25x()) {
530 mmc
->caps
|= MMC_CAP_4_BIT_DATA
| MMC_CAP_SDIO_IRQ
;
531 host
->cmdat
|= CMDAT_SDIO_INT_EN
;
534 host
->sg_cpu
= dma_alloc_coherent(&pdev
->dev
, PAGE_SIZE
, &host
->sg_dma
, GFP_KERNEL
);
540 spin_lock_init(&host
->lock
);
543 host
->imask
= MMC_I_MASK_ALL
;
545 host
->base
= ioremap(r
->start
, SZ_4K
);
552 * Ensure that the host controller is shut down, and setup
555 pxamci_stop_clock(host
);
556 writel(0, host
->base
+ MMC_SPI
);
557 writel(64, host
->base
+ MMC_RESTO
);
558 writel(host
->imask
, host
->base
+ MMC_I_MASK
);
560 host
->dma
= pxa_request_dma(DRIVER_NAME
, DMA_PRIO_LOW
,
561 pxamci_dma_irq
, host
);
567 ret
= request_irq(host
->irq
, pxamci_irq
, 0, DRIVER_NAME
, host
);
571 platform_set_drvdata(pdev
, mmc
);
573 if (host
->pdata
&& host
->pdata
->init
)
574 host
->pdata
->init(&pdev
->dev
, pxamci_detect_irq
, mmc
);
583 pxa_free_dma(host
->dma
);
587 dma_free_coherent(&pdev
->dev
, PAGE_SIZE
, host
->sg_cpu
, host
->sg_dma
);
597 static int pxamci_remove(struct platform_device
*pdev
)
599 struct mmc_host
*mmc
= platform_get_drvdata(pdev
);
601 platform_set_drvdata(pdev
, NULL
);
604 struct pxamci_host
*host
= mmc_priv(mmc
);
606 if (host
->pdata
&& host
->pdata
->exit
)
607 host
->pdata
->exit(&pdev
->dev
, mmc
);
609 mmc_remove_host(mmc
);
611 pxamci_stop_clock(host
);
612 writel(TXFIFO_WR_REQ
|RXFIFO_RD_REQ
|CLK_IS_OFF
|STOP_CMD
|
613 END_CMD_RES
|PRG_DONE
|DATA_TRAN_DONE
,
614 host
->base
+ MMC_I_MASK
);
619 free_irq(host
->irq
, host
);
620 pxa_free_dma(host
->dma
);
622 dma_free_coherent(&pdev
->dev
, PAGE_SIZE
, host
->sg_cpu
, host
->sg_dma
);
626 release_resource(host
->res
);
634 static int pxamci_suspend(struct platform_device
*dev
, pm_message_t state
)
636 struct mmc_host
*mmc
= platform_get_drvdata(dev
);
640 ret
= mmc_suspend_host(mmc
, state
);
645 static int pxamci_resume(struct platform_device
*dev
)
647 struct mmc_host
*mmc
= platform_get_drvdata(dev
);
651 ret
= mmc_resume_host(mmc
);
656 #define pxamci_suspend NULL
657 #define pxamci_resume NULL
660 static struct platform_driver pxamci_driver
= {
661 .probe
= pxamci_probe
,
662 .remove
= pxamci_remove
,
663 .suspend
= pxamci_suspend
,
664 .resume
= pxamci_resume
,
670 static int __init
pxamci_init(void)
672 return platform_driver_register(&pxamci_driver
);
675 static void __exit
pxamci_exit(void)
677 platform_driver_unregister(&pxamci_driver
);
680 module_init(pxamci_init
);
681 module_exit(pxamci_exit
);
683 MODULE_DESCRIPTION("PXA Multimedia Card Interface Driver");
684 MODULE_LICENSE("GPL");