2 * linux/drivers/mmc/mmci.c - ARM PrimeCell MMCI PL180/1 driver
4 * Copyright (C) 2003 Deep Blue Solutions, Ltd, 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 #include <linux/config.h>
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/init.h>
14 #include <linux/ioport.h>
15 #include <linux/device.h>
16 #include <linux/interrupt.h>
17 #include <linux/delay.h>
18 #include <linux/err.h>
19 #include <linux/highmem.h>
20 #include <linux/mmc/host.h>
21 #include <linux/mmc/protocol.h>
23 #include <asm/div64.h>
26 #include <asm/scatterlist.h>
27 #include <asm/sizes.h>
28 #include <asm/hardware/amba.h>
29 #include <asm/hardware/clock.h>
30 #include <asm/mach/mmc.h>
34 #define DRIVER_NAME "mmci-pl18x"
36 #ifdef CONFIG_MMC_DEBUG
37 #define DBG(host,fmt,args...) \
38 pr_debug("%s: %s: " fmt, mmc_hostname(host->mmc), __func__ , args)
40 #define DBG(host,fmt,args...) do { } while (0)
43 static unsigned int fmax
= 515633;
46 mmci_request_end(struct mmci_host
*host
, struct mmc_request
*mrq
)
48 writel(0, host
->base
+ MMCICOMMAND
);
54 mrq
->data
->bytes_xfered
= host
->data_xfered
;
57 * Need to drop the host lock here; mmc_request_done may call
58 * back into the driver...
60 spin_unlock(&host
->lock
);
61 mmc_request_done(host
->mmc
, mrq
);
62 spin_lock(&host
->lock
);
65 static void mmci_stop_data(struct mmci_host
*host
)
67 writel(0, host
->base
+ MMCIDATACTRL
);
68 writel(0, host
->base
+ MMCIMASK1
);
72 static void mmci_start_data(struct mmci_host
*host
, struct mmc_data
*data
)
74 unsigned int datactrl
, timeout
, irqmask
;
75 unsigned long long clks
;
78 DBG(host
, "blksz %04x blks %04x flags %08x\n",
79 1 << data
->blksz_bits
, data
->blocks
, data
->flags
);
82 host
->size
= data
->blocks
<< data
->blksz_bits
;
83 host
->data_xfered
= 0;
85 mmci_init_sg(host
, data
);
87 clks
= (unsigned long long)data
->timeout_ns
* host
->cclk
;
88 do_div(clks
, 1000000000UL);
90 timeout
= data
->timeout_clks
+ (unsigned int)clks
;
93 writel(timeout
, base
+ MMCIDATATIMER
);
94 writel(host
->size
, base
+ MMCIDATALENGTH
);
96 datactrl
= MCI_DPSM_ENABLE
| data
->blksz_bits
<< 4;
97 if (data
->flags
& MMC_DATA_READ
) {
98 datactrl
|= MCI_DPSM_DIRECTION
;
99 irqmask
= MCI_RXFIFOHALFFULLMASK
;
102 * We don't actually need to include "FIFO empty" here
103 * since its implicit in "FIFO half empty".
105 irqmask
= MCI_TXFIFOHALFEMPTYMASK
;
108 writel(datactrl
, base
+ MMCIDATACTRL
);
109 writel(readl(base
+ MMCIMASK0
) & ~MCI_DATAENDMASK
, base
+ MMCIMASK0
);
110 writel(irqmask
, base
+ MMCIMASK1
);
114 mmci_start_command(struct mmci_host
*host
, struct mmc_command
*cmd
, u32 c
)
116 void __iomem
*base
= host
->base
;
118 DBG(host
, "op %02x arg %08x flags %08x\n",
119 cmd
->opcode
, cmd
->arg
, cmd
->flags
);
121 if (readl(base
+ MMCICOMMAND
) & MCI_CPSM_ENABLE
) {
122 writel(0, base
+ MMCICOMMAND
);
126 c
|= cmd
->opcode
| MCI_CPSM_ENABLE
;
127 switch (cmd
->flags
& MMC_RSP_MASK
) {
132 c
|= MCI_CPSM_LONGRSP
;
134 c
|= MCI_CPSM_RESPONSE
;
138 c
|= MCI_CPSM_INTERRUPT
;
142 writel(cmd
->arg
, base
+ MMCIARGUMENT
);
143 writel(c
, base
+ MMCICOMMAND
);
147 mmci_data_irq(struct mmci_host
*host
, struct mmc_data
*data
,
150 if (status
& MCI_DATABLOCKEND
) {
151 host
->data_xfered
+= 1 << data
->blksz_bits
;
153 if (status
& (MCI_DATACRCFAIL
|MCI_DATATIMEOUT
|MCI_TXUNDERRUN
|MCI_RXOVERRUN
)) {
154 if (status
& MCI_DATACRCFAIL
)
155 data
->error
= MMC_ERR_BADCRC
;
156 else if (status
& MCI_DATATIMEOUT
)
157 data
->error
= MMC_ERR_TIMEOUT
;
158 else if (status
& (MCI_TXUNDERRUN
|MCI_RXOVERRUN
))
159 data
->error
= MMC_ERR_FIFO
;
160 status
|= MCI_DATAEND
;
162 if (status
& MCI_DATAEND
) {
163 mmci_stop_data(host
);
166 mmci_request_end(host
, data
->mrq
);
168 mmci_start_command(host
, data
->stop
, 0);
174 mmci_cmd_irq(struct mmci_host
*host
, struct mmc_command
*cmd
,
177 void __iomem
*base
= host
->base
;
181 cmd
->resp
[0] = readl(base
+ MMCIRESPONSE0
);
182 cmd
->resp
[1] = readl(base
+ MMCIRESPONSE1
);
183 cmd
->resp
[2] = readl(base
+ MMCIRESPONSE2
);
184 cmd
->resp
[3] = readl(base
+ MMCIRESPONSE3
);
186 if (status
& MCI_CMDTIMEOUT
) {
187 cmd
->error
= MMC_ERR_TIMEOUT
;
188 } else if (status
& MCI_CMDCRCFAIL
&& cmd
->flags
& MMC_RSP_CRC
) {
189 cmd
->error
= MMC_ERR_BADCRC
;
192 if (!cmd
->data
|| cmd
->error
!= MMC_ERR_NONE
) {
193 mmci_request_end(host
, cmd
->mrq
);
194 } else if (!(cmd
->data
->flags
& MMC_DATA_READ
)) {
195 mmci_start_data(host
, cmd
->data
);
199 static int mmci_pio_read(struct mmci_host
*host
, char *buffer
, unsigned int remain
)
201 void __iomem
*base
= host
->base
;
206 int count
= host
->size
- (readl(base
+ MMCIFIFOCNT
) << 2);
214 readsl(base
+ MMCIFIFO
, ptr
, count
>> 2);
222 status
= readl(base
+ MMCISTATUS
);
223 } while (status
& MCI_RXDATAAVLBL
);
228 static int mmci_pio_write(struct mmci_host
*host
, char *buffer
, unsigned int remain
, u32 status
)
230 void __iomem
*base
= host
->base
;
234 unsigned int count
, maxcnt
;
236 maxcnt
= status
& MCI_TXFIFOEMPTY
? MCI_FIFOSIZE
: MCI_FIFOHALFSIZE
;
237 count
= min(remain
, maxcnt
);
239 writesl(base
+ MMCIFIFO
, ptr
, count
>> 2);
247 status
= readl(base
+ MMCISTATUS
);
248 } while (status
& MCI_TXFIFOHALFEMPTY
);
254 * PIO data transfer IRQ handler.
256 static irqreturn_t
mmci_pio_irq(int irq
, void *dev_id
, struct pt_regs
*regs
)
258 struct mmci_host
*host
= dev_id
;
259 void __iomem
*base
= host
->base
;
262 status
= readl(base
+ MMCISTATUS
);
264 DBG(host
, "irq1 %08x\n", status
);
268 unsigned int remain
, len
;
272 * For write, we only need to test the half-empty flag
273 * here - if the FIFO is completely empty, then by
274 * definition it is more than half empty.
276 * For read, check for data available.
278 if (!(status
& (MCI_TXFIFOHALFEMPTY
|MCI_RXDATAAVLBL
)))
282 * Map the current scatter buffer.
284 buffer
= mmci_kmap_atomic(host
, &flags
) + host
->sg_off
;
285 remain
= host
->sg_ptr
->length
- host
->sg_off
;
288 if (status
& MCI_RXACTIVE
)
289 len
= mmci_pio_read(host
, buffer
, remain
);
290 if (status
& MCI_TXACTIVE
)
291 len
= mmci_pio_write(host
, buffer
, remain
, status
);
296 mmci_kunmap_atomic(host
, &flags
);
305 if (!mmci_next_sg(host
))
308 status
= readl(base
+ MMCISTATUS
);
312 * If we're nearing the end of the read, switch to
313 * "any data available" mode.
315 if (status
& MCI_RXACTIVE
&& host
->size
< MCI_FIFOSIZE
)
316 writel(MCI_RXDATAAVLBLMASK
, base
+ MMCIMASK1
);
319 * If we run out of data, disable the data IRQs; this
320 * prevents a race where the FIFO becomes empty before
321 * the chip itself has disabled the data path, and
322 * stops us racing with our data end IRQ.
324 if (host
->size
== 0) {
325 writel(0, base
+ MMCIMASK1
);
326 writel(readl(base
+ MMCIMASK0
) | MCI_DATAENDMASK
, base
+ MMCIMASK0
);
333 * Handle completion of command and data transfers.
335 static irqreturn_t
mmci_irq(int irq
, void *dev_id
, struct pt_regs
*regs
)
337 struct mmci_host
*host
= dev_id
;
341 spin_lock(&host
->lock
);
344 struct mmc_command
*cmd
;
345 struct mmc_data
*data
;
347 status
= readl(host
->base
+ MMCISTATUS
);
348 status
&= readl(host
->base
+ MMCIMASK0
);
349 writel(status
, host
->base
+ MMCICLEAR
);
351 DBG(host
, "irq0 %08x\n", status
);
354 if (status
& (MCI_DATACRCFAIL
|MCI_DATATIMEOUT
|MCI_TXUNDERRUN
|
355 MCI_RXOVERRUN
|MCI_DATAEND
|MCI_DATABLOCKEND
) && data
)
356 mmci_data_irq(host
, data
, status
);
359 if (status
& (MCI_CMDCRCFAIL
|MCI_CMDTIMEOUT
|MCI_CMDSENT
|MCI_CMDRESPEND
) && cmd
)
360 mmci_cmd_irq(host
, cmd
, status
);
365 spin_unlock(&host
->lock
);
367 return IRQ_RETVAL(ret
);
370 static void mmci_request(struct mmc_host
*mmc
, struct mmc_request
*mrq
)
372 struct mmci_host
*host
= mmc_priv(mmc
);
374 WARN_ON(host
->mrq
!= NULL
);
376 spin_lock_irq(&host
->lock
);
380 if (mrq
->data
&& mrq
->data
->flags
& MMC_DATA_READ
)
381 mmci_start_data(host
, mrq
->data
);
383 mmci_start_command(host
, mrq
->cmd
, 0);
385 spin_unlock_irq(&host
->lock
);
388 static void mmci_set_ios(struct mmc_host
*mmc
, struct mmc_ios
*ios
)
390 struct mmci_host
*host
= mmc_priv(mmc
);
391 u32 clk
= 0, pwr
= 0;
393 DBG(host
, "clock %uHz busmode %u powermode %u Vdd %u\n",
394 ios
->clock
, ios
->bus_mode
, ios
->power_mode
, ios
->vdd
);
397 if (ios
->clock
>= host
->mclk
) {
398 clk
= MCI_CLK_BYPASS
;
399 host
->cclk
= host
->mclk
;
401 clk
= host
->mclk
/ (2 * ios
->clock
) - 1;
404 host
->cclk
= host
->mclk
/ (2 * (clk
+ 1));
406 clk
|= MCI_CLK_ENABLE
;
409 if (host
->plat
->translate_vdd
)
410 pwr
|= host
->plat
->translate_vdd(mmc_dev(mmc
), ios
->vdd
);
412 switch (ios
->power_mode
) {
423 if (ios
->bus_mode
== MMC_BUSMODE_OPENDRAIN
)
426 writel(clk
, host
->base
+ MMCICLOCK
);
428 if (host
->pwr
!= pwr
) {
430 writel(pwr
, host
->base
+ MMCIPOWER
);
434 static struct mmc_host_ops mmci_ops
= {
435 .request
= mmci_request
,
436 .set_ios
= mmci_set_ios
,
439 static void mmci_check_status(unsigned long data
)
441 struct mmci_host
*host
= (struct mmci_host
*)data
;
444 status
= host
->plat
->status(mmc_dev(host
->mmc
));
445 if (status
^ host
->oldstat
)
446 mmc_detect_change(host
->mmc
, 0);
448 host
->oldstat
= status
;
449 mod_timer(&host
->timer
, jiffies
+ HZ
);
452 static int mmci_probe(struct amba_device
*dev
, void *id
)
454 struct mmc_platform_data
*plat
= dev
->dev
.platform_data
;
455 struct mmci_host
*host
;
456 struct mmc_host
*mmc
;
459 /* must have platform data */
465 ret
= amba_request_regions(dev
, DRIVER_NAME
);
469 mmc
= mmc_alloc_host(sizeof(struct mmci_host
), &dev
->dev
);
475 host
= mmc_priv(mmc
);
476 host
->clk
= clk_get(&dev
->dev
, "MCLK");
477 if (IS_ERR(host
->clk
)) {
478 ret
= PTR_ERR(host
->clk
);
483 ret
= clk_use(host
->clk
);
487 ret
= clk_enable(host
->clk
);
492 host
->mclk
= clk_get_rate(host
->clk
);
494 host
->base
= ioremap(dev
->res
.start
, SZ_4K
);
500 mmc
->ops
= &mmci_ops
;
501 mmc
->f_min
= (host
->mclk
+ 511) / 512;
502 mmc
->f_max
= min(host
->mclk
, fmax
);
503 mmc
->ocr_avail
= plat
->ocr_mask
;
508 mmc
->max_hw_segs
= 16;
509 mmc
->max_phys_segs
= NR_SG
;
512 * Since we only have a 16-bit data length register, we must
513 * ensure that we don't exceed 2^16-1 bytes in a single request.
514 * Choose 64 (512-byte) sectors as the limit.
516 mmc
->max_sectors
= 64;
519 * Set the maximum segment size. Since we aren't doing DMA
520 * (yet) we are only limited by the data length register.
522 mmc
->max_seg_size
= mmc
->max_sectors
<< 9;
524 spin_lock_init(&host
->lock
);
526 writel(0, host
->base
+ MMCIMASK0
);
527 writel(0, host
->base
+ MMCIMASK1
);
528 writel(0xfff, host
->base
+ MMCICLEAR
);
530 ret
= request_irq(dev
->irq
[0], mmci_irq
, SA_SHIRQ
, DRIVER_NAME
" (cmd)", host
);
534 ret
= request_irq(dev
->irq
[1], mmci_pio_irq
, SA_SHIRQ
, DRIVER_NAME
" (pio)", host
);
538 writel(MCI_IRQENABLE
, host
->base
+ MMCIMASK0
);
540 amba_set_drvdata(dev
, mmc
);
544 printk(KERN_INFO
"%s: MMCI rev %x cfg %02x at 0x%08lx irq %d,%d\n",
545 mmc_hostname(mmc
), amba_rev(dev
), amba_config(dev
),
546 dev
->res
.start
, dev
->irq
[0], dev
->irq
[1]);
548 init_timer(&host
->timer
);
549 host
->timer
.data
= (unsigned long)host
;
550 host
->timer
.function
= mmci_check_status
;
551 host
->timer
.expires
= jiffies
+ HZ
;
552 add_timer(&host
->timer
);
557 free_irq(dev
->irq
[0], host
);
561 clk_disable(host
->clk
);
563 clk_unuse(host
->clk
);
569 amba_release_regions(dev
);
574 static int mmci_remove(struct amba_device
*dev
)
576 struct mmc_host
*mmc
= amba_get_drvdata(dev
);
578 amba_set_drvdata(dev
, NULL
);
581 struct mmci_host
*host
= mmc_priv(mmc
);
583 del_timer_sync(&host
->timer
);
585 mmc_remove_host(mmc
);
587 writel(0, host
->base
+ MMCIMASK0
);
588 writel(0, host
->base
+ MMCIMASK1
);
590 writel(0, host
->base
+ MMCICOMMAND
);
591 writel(0, host
->base
+ MMCIDATACTRL
);
593 free_irq(dev
->irq
[0], host
);
594 free_irq(dev
->irq
[1], host
);
597 clk_disable(host
->clk
);
598 clk_unuse(host
->clk
);
603 amba_release_regions(dev
);
610 static int mmci_suspend(struct amba_device
*dev
, pm_message_t state
)
612 struct mmc_host
*mmc
= amba_get_drvdata(dev
);
616 struct mmci_host
*host
= mmc_priv(mmc
);
618 ret
= mmc_suspend_host(mmc
, state
);
620 writel(0, host
->base
+ MMCIMASK0
);
626 static int mmci_resume(struct amba_device
*dev
)
628 struct mmc_host
*mmc
= amba_get_drvdata(dev
);
632 struct mmci_host
*host
= mmc_priv(mmc
);
634 writel(MCI_IRQENABLE
, host
->base
+ MMCIMASK0
);
636 ret
= mmc_resume_host(mmc
);
642 #define mmci_suspend NULL
643 #define mmci_resume NULL
646 static struct amba_id mmci_ids
[] = {
658 static struct amba_driver mmci_driver
= {
663 .remove
= mmci_remove
,
664 .suspend
= mmci_suspend
,
665 .resume
= mmci_resume
,
666 .id_table
= mmci_ids
,
669 static int __init
mmci_init(void)
671 return amba_driver_register(&mmci_driver
);
674 static void __exit
mmci_exit(void)
676 amba_driver_unregister(&mmci_driver
);
679 module_init(mmci_init
);
680 module_exit(mmci_exit
);
681 module_param(fmax
, uint
, 0444);
683 MODULE_DESCRIPTION("ARM PrimeCell PL180/181 Multimedia Card Interface driver");
684 MODULE_LICENSE("GPL");