2 * linux/drivers/mmc/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/config.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/ioport.h>
23 #include <linux/device.h>
24 #include <linux/delay.h>
25 #include <linux/interrupt.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/mmc/host.h>
28 #include <linux/mmc/protocol.h>
33 #include <asm/scatterlist.h>
34 #include <asm/sizes.h>
36 #include <asm/arch/pxa-regs.h>
37 #include <asm/arch/mmc.h>
41 #ifdef CONFIG_MMC_DEBUG
42 #define DBG(x...) printk(KERN_DEBUG x)
44 #define DBG(x...) do { } while (0)
47 #define DRIVER_NAME "pxa2xx-mci"
61 unsigned int power_mode
;
62 struct pxamci_platform_data
*pdata
;
64 struct mmc_request
*mrq
;
65 struct mmc_command
*cmd
;
66 struct mmc_data
*data
;
69 struct pxa_dma_desc
*sg_cpu
;
75 static inline unsigned int ns_to_clocks(unsigned int ns
)
77 return (ns
* (CLOCKRATE
/ 1000000) + 999) / 1000;
80 static void pxamci_stop_clock(struct pxamci_host
*host
)
82 if (readl(host
->base
+ MMC_STAT
) & STAT_CLK_EN
) {
83 unsigned long timeout
= 10000;
86 writel(STOP_CLOCK
, host
->base
+ MMC_STRPCL
);
89 v
= readl(host
->base
+ MMC_STAT
);
90 if (!(v
& STAT_CLK_EN
))
96 dev_err(mmc_dev(host
->mmc
), "unable to stop clock\n");
100 static void pxamci_enable_irq(struct pxamci_host
*host
, unsigned int mask
)
104 spin_lock_irqsave(&host
->lock
, flags
);
105 host
->imask
&= ~mask
;
106 writel(host
->imask
, host
->base
+ MMC_I_MASK
);
107 spin_unlock_irqrestore(&host
->lock
, flags
);
110 static void pxamci_disable_irq(struct pxamci_host
*host
, unsigned int mask
)
114 spin_lock_irqsave(&host
->lock
, flags
);
116 writel(host
->imask
, host
->base
+ MMC_I_MASK
);
117 spin_unlock_irqrestore(&host
->lock
, flags
);
120 static void pxamci_setup_data(struct pxamci_host
*host
, struct mmc_data
*data
)
122 unsigned int nob
= data
->blocks
;
123 unsigned int timeout
;
129 if (data
->flags
& MMC_DATA_STREAM
)
132 writel(nob
, host
->base
+ MMC_NOB
);
133 writel(1 << data
->blksz_bits
, host
->base
+ MMC_BLKLEN
);
135 timeout
= ns_to_clocks(data
->timeout_ns
) + data
->timeout_clks
;
136 writel((timeout
+ 255) / 256, host
->base
+ MMC_RDTO
);
138 if (data
->flags
& MMC_DATA_READ
) {
139 host
->dma_dir
= DMA_FROM_DEVICE
;
140 dcmd
= DCMD_INCTRGADDR
| DCMD_FLOWTRG
;
142 DRCMRRXMMC
= host
->dma
| DRCMR_MAPVLD
;
144 host
->dma_dir
= DMA_TO_DEVICE
;
145 dcmd
= DCMD_INCSRCADDR
| DCMD_FLOWSRC
;
147 DRCMRTXMMC
= host
->dma
| DRCMR_MAPVLD
;
150 dcmd
|= DCMD_BURST32
| DCMD_WIDTH1
;
152 host
->dma_len
= dma_map_sg(mmc_dev(host
->mmc
), data
->sg
, data
->sg_len
,
155 for (i
= 0; i
< host
->dma_len
; i
++) {
156 if (data
->flags
& MMC_DATA_READ
) {
157 host
->sg_cpu
[i
].dsadr
= host
->res
->start
+ MMC_RXFIFO
;
158 host
->sg_cpu
[i
].dtadr
= sg_dma_address(&data
->sg
[i
]);
160 host
->sg_cpu
[i
].dsadr
= sg_dma_address(&data
->sg
[i
]);
161 host
->sg_cpu
[i
].dtadr
= host
->res
->start
+ MMC_TXFIFO
;
163 host
->sg_cpu
[i
].dcmd
= dcmd
| sg_dma_len(&data
->sg
[i
]);
164 host
->sg_cpu
[i
].ddadr
= host
->sg_dma
+ (i
+ 1) *
165 sizeof(struct pxa_dma_desc
);
167 host
->sg_cpu
[host
->dma_len
- 1].ddadr
= DDADR_STOP
;
170 DDADR(host
->dma
) = host
->sg_dma
;
171 DCSR(host
->dma
) = DCSR_RUN
;
174 static void pxamci_start_cmd(struct pxamci_host
*host
, struct mmc_command
*cmd
, unsigned int cmdat
)
176 WARN_ON(host
->cmd
!= NULL
);
179 if (cmd
->flags
& MMC_RSP_BUSY
)
182 switch (cmd
->flags
& (MMC_RSP_MASK
| MMC_RSP_CRC
)) {
183 case MMC_RSP_SHORT
| MMC_RSP_CRC
:
184 cmdat
|= CMDAT_RESP_SHORT
;
187 cmdat
|= CMDAT_RESP_R3
;
189 case MMC_RSP_LONG
| MMC_RSP_CRC
:
190 cmdat
|= CMDAT_RESP_R2
;
196 writel(cmd
->opcode
, host
->base
+ MMC_CMD
);
197 writel(cmd
->arg
>> 16, host
->base
+ MMC_ARGH
);
198 writel(cmd
->arg
& 0xffff, host
->base
+ MMC_ARGL
);
199 writel(cmdat
, host
->base
+ MMC_CMDAT
);
200 writel(host
->clkrt
, host
->base
+ MMC_CLKRT
);
202 writel(START_CLOCK
, host
->base
+ MMC_STRPCL
);
204 pxamci_enable_irq(host
, END_CMD_RES
);
207 static void pxamci_finish_request(struct pxamci_host
*host
, struct mmc_request
*mrq
)
209 DBG("PXAMCI: request done\n");
213 mmc_request_done(host
->mmc
, mrq
);
216 static int pxamci_cmd_done(struct pxamci_host
*host
, unsigned int stat
)
218 struct mmc_command
*cmd
= host
->cmd
;
228 * Did I mention this is Sick. We always need to
229 * discard the upper 8 bits of the first 16-bit word.
231 v
= readl(host
->base
+ MMC_RES
) & 0xffff;
232 for (i
= 0; i
< 4; i
++) {
233 u32 w1
= readl(host
->base
+ MMC_RES
) & 0xffff;
234 u32 w2
= readl(host
->base
+ MMC_RES
) & 0xffff;
235 cmd
->resp
[i
] = v
<< 24 | w1
<< 8 | w2
>> 8;
239 if (stat
& STAT_TIME_OUT_RESPONSE
) {
240 cmd
->error
= MMC_ERR_TIMEOUT
;
241 } else if (stat
& STAT_RES_CRC_ERR
&& cmd
->flags
& MMC_RSP_CRC
) {
244 * workaround for erratum #42:
245 * Intel PXA27x Family Processor Specification Update Rev 001
247 if (cmd
->opcode
== MMC_ALL_SEND_CID
||
248 cmd
->opcode
== MMC_SEND_CSD
||
249 cmd
->opcode
== MMC_SEND_CID
) {
250 /* a bogus CRC error can appear if the msb of
251 the 15 byte response is a one */
252 if ((cmd
->resp
[0] & 0x80000000) == 0)
253 cmd
->error
= MMC_ERR_BADCRC
;
255 DBG("ignoring CRC from command %d - *risky*\n",cmd
->opcode
);
258 cmd
->error
= MMC_ERR_BADCRC
;
262 pxamci_disable_irq(host
, END_CMD_RES
);
263 if (host
->data
&& cmd
->error
== MMC_ERR_NONE
) {
264 pxamci_enable_irq(host
, DATA_TRAN_DONE
);
266 pxamci_finish_request(host
, host
->mrq
);
272 static int pxamci_data_done(struct pxamci_host
*host
, unsigned int stat
)
274 struct mmc_data
*data
= host
->data
;
280 dma_unmap_sg(mmc_dev(host
->mmc
), data
->sg
, host
->dma_len
,
283 if (stat
& STAT_READ_TIME_OUT
)
284 data
->error
= MMC_ERR_TIMEOUT
;
285 else if (stat
& (STAT_CRC_READ_ERROR
|STAT_CRC_WRITE_ERROR
))
286 data
->error
= MMC_ERR_BADCRC
;
289 * There appears to be a hardware design bug here. There seems to
290 * be no way to find out how much data was transferred to the card.
291 * This means that if there was an error on any block, we mark all
292 * data blocks as being in error.
294 if (data
->error
== MMC_ERR_NONE
)
295 data
->bytes_xfered
= data
->blocks
<< data
->blksz_bits
;
297 data
->bytes_xfered
= 0;
299 pxamci_disable_irq(host
, DATA_TRAN_DONE
);
302 if (host
->mrq
->stop
&& data
->error
== MMC_ERR_NONE
) {
303 pxamci_stop_clock(host
);
304 pxamci_start_cmd(host
, host
->mrq
->stop
, 0);
306 pxamci_finish_request(host
, host
->mrq
);
312 static irqreturn_t
pxamci_irq(int irq
, void *devid
, struct pt_regs
*regs
)
314 struct pxamci_host
*host
= devid
;
318 ireg
= readl(host
->base
+ MMC_I_REG
);
320 DBG("PXAMCI: irq %08x\n", ireg
);
323 unsigned stat
= readl(host
->base
+ MMC_STAT
);
325 DBG("PXAMCI: stat %08x\n", stat
);
327 if (ireg
& END_CMD_RES
)
328 handled
|= pxamci_cmd_done(host
, stat
);
329 if (ireg
& DATA_TRAN_DONE
)
330 handled
|= pxamci_data_done(host
, stat
);
333 return IRQ_RETVAL(handled
);
336 static void pxamci_request(struct mmc_host
*mmc
, struct mmc_request
*mrq
)
338 struct pxamci_host
*host
= mmc_priv(mmc
);
341 WARN_ON(host
->mrq
!= NULL
);
345 pxamci_stop_clock(host
);
348 host
->cmdat
&= ~CMDAT_INIT
;
351 pxamci_setup_data(host
, mrq
->data
);
353 cmdat
&= ~CMDAT_BUSY
;
354 cmdat
|= CMDAT_DATAEN
| CMDAT_DMAEN
;
355 if (mrq
->data
->flags
& MMC_DATA_WRITE
)
356 cmdat
|= CMDAT_WRITE
;
358 if (mrq
->data
->flags
& MMC_DATA_STREAM
)
359 cmdat
|= CMDAT_STREAM
;
362 pxamci_start_cmd(host
, mrq
->cmd
, cmdat
);
365 static void pxamci_set_ios(struct mmc_host
*mmc
, struct mmc_ios
*ios
)
367 struct pxamci_host
*host
= mmc_priv(mmc
);
369 DBG("pxamci_set_ios: clock %u power %u vdd %u.%02u\n",
370 ios
->clock
, ios
->power_mode
, ios
->vdd
/ 100,
374 unsigned int clk
= CLOCKRATE
/ ios
->clock
;
375 if (CLOCKRATE
/ clk
> ios
->clock
)
377 host
->clkrt
= fls(clk
) - 1;
378 pxa_set_cken(CKEN12_MMC
, 1);
381 * we write clkrt on the next command
384 pxamci_stop_clock(host
);
385 pxa_set_cken(CKEN12_MMC
, 0);
388 if (host
->power_mode
!= ios
->power_mode
) {
389 host
->power_mode
= ios
->power_mode
;
391 if (host
->pdata
&& host
->pdata
->setpower
)
392 host
->pdata
->setpower(mmc
->dev
, ios
->vdd
);
394 if (ios
->power_mode
== MMC_POWER_ON
)
395 host
->cmdat
|= CMDAT_INIT
;
398 DBG("pxamci_set_ios: clkrt = %x cmdat = %x\n",
399 host
->clkrt
, host
->cmdat
);
402 static struct mmc_host_ops pxamci_ops
= {
403 .request
= pxamci_request
,
404 .set_ios
= pxamci_set_ios
,
407 static void pxamci_dma_irq(int dma
, void *devid
, struct pt_regs
*regs
)
409 printk(KERN_ERR
"DMA%d: IRQ???\n", dma
);
410 DCSR(dma
) = DCSR_STARTINTR
|DCSR_ENDINTR
|DCSR_BUSERR
;
413 static irqreturn_t
pxamci_detect_irq(int irq
, void *devid
, struct pt_regs
*regs
)
415 mmc_detect_change(devid
);
419 static int pxamci_probe(struct device
*dev
)
421 struct platform_device
*pdev
= to_platform_device(dev
);
422 struct mmc_host
*mmc
;
423 struct pxamci_host
*host
= NULL
;
427 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
428 irq
= platform_get_irq(pdev
, 0);
429 if (!r
|| irq
== NO_IRQ
)
432 r
= request_mem_region(r
->start
, SZ_4K
, DRIVER_NAME
);
436 mmc
= mmc_alloc_host(sizeof(struct pxamci_host
), dev
);
442 mmc
->ops
= &pxamci_ops
;
443 mmc
->f_min
= CLOCKRATE_MIN
;
444 mmc
->f_max
= CLOCKRATE_MAX
;
447 * We can do SG-DMA, but we don't because we never know how much
448 * data we successfully wrote to the card.
450 mmc
->max_phys_segs
= NR_SG
;
453 * Our hardware DMA can handle a maximum of one page per SG entry.
455 mmc
->max_seg_size
= PAGE_SIZE
;
457 host
= mmc_priv(mmc
);
460 host
->pdata
= pdev
->dev
.platform_data
;
461 mmc
->ocr_avail
= host
->pdata
?
462 host
->pdata
->ocr_mask
:
463 MMC_VDD_32_33
|MMC_VDD_33_34
;
465 host
->sg_cpu
= dma_alloc_coherent(dev
, PAGE_SIZE
, &host
->sg_dma
, GFP_KERNEL
);
471 spin_lock_init(&host
->lock
);
474 host
->imask
= MMC_I_MASK_ALL
;
476 host
->base
= ioremap(r
->start
, SZ_4K
);
483 * Ensure that the host controller is shut down, and setup
486 pxamci_stop_clock(host
);
487 writel(0, host
->base
+ MMC_SPI
);
488 writel(64, host
->base
+ MMC_RESTO
);
489 writel(host
->imask
, host
->base
+ MMC_I_MASK
);
491 host
->dma
= pxa_request_dma(DRIVER_NAME
, DMA_PRIO_LOW
,
492 pxamci_dma_irq
, host
);
498 ret
= request_irq(host
->irq
, pxamci_irq
, 0, DRIVER_NAME
, host
);
502 dev_set_drvdata(dev
, mmc
);
504 if (host
->pdata
&& host
->pdata
->init
)
505 host
->pdata
->init(dev
, pxamci_detect_irq
, mmc
);
514 pxa_free_dma(host
->dma
);
518 dma_free_coherent(dev
, PAGE_SIZE
, host
->sg_cpu
, host
->sg_dma
);
526 static int pxamci_remove(struct device
*dev
)
528 struct mmc_host
*mmc
= dev_get_drvdata(dev
);
530 dev_set_drvdata(dev
, NULL
);
533 struct pxamci_host
*host
= mmc_priv(mmc
);
535 if (host
->pdata
&& host
->pdata
->exit
)
536 host
->pdata
->exit(dev
, mmc
);
538 mmc_remove_host(mmc
);
540 pxamci_stop_clock(host
);
541 writel(TXFIFO_WR_REQ
|RXFIFO_RD_REQ
|CLK_IS_OFF
|STOP_CMD
|
542 END_CMD_RES
|PRG_DONE
|DATA_TRAN_DONE
,
543 host
->base
+ MMC_I_MASK
);
548 free_irq(host
->irq
, host
);
549 pxa_free_dma(host
->dma
);
551 dma_free_coherent(dev
, PAGE_SIZE
, host
->sg_cpu
, host
->sg_dma
);
553 release_resource(host
->res
);
561 static int pxamci_suspend(struct device
*dev
, pm_message_t state
, u32 level
)
563 struct mmc_host
*mmc
= dev_get_drvdata(dev
);
566 if (mmc
&& level
== SUSPEND_DISABLE
)
567 ret
= mmc_suspend_host(mmc
, state
);
572 static int pxamci_resume(struct device
*dev
, u32 level
)
574 struct mmc_host
*mmc
= dev_get_drvdata(dev
);
577 if (mmc
&& level
== RESUME_ENABLE
)
578 ret
= mmc_resume_host(mmc
);
583 #define pxamci_suspend NULL
584 #define pxamci_resume NULL
587 static struct device_driver pxamci_driver
= {
589 .bus
= &platform_bus_type
,
590 .probe
= pxamci_probe
,
591 .remove
= pxamci_remove
,
592 .suspend
= pxamci_suspend
,
593 .resume
= pxamci_resume
,
596 static int __init
pxamci_init(void)
598 return driver_register(&pxamci_driver
);
601 static void __exit
pxamci_exit(void)
603 driver_unregister(&pxamci_driver
);
606 module_init(pxamci_init
);
607 module_exit(pxamci_exit
);
609 MODULE_DESCRIPTION("PXA Multimedia Card Interface Driver");
610 MODULE_LICENSE("GPL");