2 * bfin_sdh.c - Analog Devices Blackfin SDH Controller
4 * Copyright (C) 2007-2009 Analog Device Inc.
6 * Licensed under the GPL-2 or later.
9 #define DRIVER_NAME "bfin-sdh"
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/ioport.h>
14 #include <linux/platform_device.h>
15 #include <linux/delay.h>
16 #include <linux/interrupt.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/mmc/host.h>
19 #include <linux/proc_fs.h>
21 #include <asm/cacheflush.h>
23 #include <asm/portmux.h>
24 #include <asm/bfin_sdh.h>
26 #if defined(CONFIG_BF51x)
27 #define bfin_read_SDH_PWR_CTL bfin_read_RSI_PWR_CTL
28 #define bfin_write_SDH_PWR_CTL bfin_write_RSI_PWR_CTL
29 #define bfin_read_SDH_CLK_CTL bfin_read_RSI_CLK_CTL
30 #define bfin_write_SDH_CLK_CTL bfin_write_RSI_CLK_CTL
31 #define bfin_write_SDH_ARGUMENT bfin_write_RSI_ARGUMENT
32 #define bfin_write_SDH_COMMAND bfin_write_RSI_COMMAND
33 #define bfin_write_SDH_DATA_TIMER bfin_write_RSI_DATA_TIMER
34 #define bfin_read_SDH_RESPONSE0 bfin_read_RSI_RESPONSE0
35 #define bfin_read_SDH_RESPONSE1 bfin_read_RSI_RESPONSE1
36 #define bfin_read_SDH_RESPONSE2 bfin_read_RSI_RESPONSE2
37 #define bfin_read_SDH_RESPONSE3 bfin_read_RSI_RESPONSE3
38 #define bfin_write_SDH_DATA_LGTH bfin_write_RSI_DATA_LGTH
39 #define bfin_read_SDH_DATA_CTL bfin_read_RSI_DATA_CTL
40 #define bfin_write_SDH_DATA_CTL bfin_write_RSI_DATA_CTL
41 #define bfin_read_SDH_DATA_CNT bfin_read_RSI_DATA_CNT
42 #define bfin_write_SDH_STATUS_CLR bfin_write_RSI_STATUS_CLR
43 #define bfin_read_SDH_E_STATUS bfin_read_RSI_E_STATUS
44 #define bfin_write_SDH_E_STATUS bfin_write_RSI_E_STATUS
45 #define bfin_read_SDH_STATUS bfin_read_RSI_STATUS
46 #define bfin_write_SDH_MASK0 bfin_write_RSI_MASK0
47 #define bfin_read_SDH_CFG bfin_read_RSI_CFG
48 #define bfin_write_SDH_CFG bfin_write_RSI_CFG
51 struct dma_desc_array {
52 unsigned long start_addr;
54 unsigned short x_count;
67 struct dma_desc_array *sg_cpu;
72 unsigned int power_mode;
75 struct mmc_request *mrq;
76 struct mmc_command *cmd;
77 struct mmc_data *data;
80 static struct bfin_sd_host *get_sdh_data(struct platform_device *pdev)
82 return pdev->dev.platform_data;
85 static void sdh_stop_clock(struct sdh_host *host)
87 bfin_write_SDH_CLK_CTL(bfin_read_SDH_CLK_CTL() & ~CLK_E);
91 static void sdh_enable_stat_irq(struct sdh_host *host, unsigned int mask)
95 spin_lock_irqsave(&host->lock, flags);
97 bfin_write_SDH_MASK0(mask);
99 spin_unlock_irqrestore(&host->lock, flags);
102 static void sdh_disable_stat_irq(struct sdh_host *host, unsigned int mask)
106 spin_lock_irqsave(&host->lock, flags);
107 host->imask &= ~mask;
108 bfin_write_SDH_MASK0(host->imask);
110 spin_unlock_irqrestore(&host->lock, flags);
113 static int sdh_setup_data(struct sdh_host *host, struct mmc_data *data)
116 unsigned int data_ctl;
117 unsigned int dma_cfg;
118 unsigned int cycle_ns, timeout;
120 dev_dbg(mmc_dev(host->mmc), "%s enter flags: 0x%x\n", __func__, data->flags);
125 length = data->blksz * data->blocks;
126 bfin_write_SDH_DATA_LGTH(length);
128 if (data->flags & MMC_DATA_STREAM)
129 data_ctl |= DTX_MODE;
131 if (data->flags & MMC_DATA_READ)
133 /* Only supports power-of-2 block size */
134 if (data->blksz & (data->blksz - 1))
136 data_ctl |= ((ffs(data->blksz) - 1) << 4);
138 bfin_write_SDH_DATA_CTL(data_ctl);
139 /* the time of a host clock period in ns */
140 cycle_ns = 1000000000 / (get_sclk() / (2 * (host->clk_div + 1)));
141 timeout = data->timeout_ns / cycle_ns;
142 timeout += data->timeout_clks;
143 bfin_write_SDH_DATA_TIMER(timeout);
146 if (data->flags & MMC_DATA_READ) {
147 host->dma_dir = DMA_FROM_DEVICE;
150 host->dma_dir = DMA_TO_DEVICE;
152 sdh_enable_stat_irq(host, (DAT_CRC_FAIL | DAT_TIME_OUT | DAT_END));
153 host->dma_len = dma_map_sg(mmc_dev(host->mmc), data->sg, data->sg_len, host->dma_dir);
154 #if defined(CONFIG_BF54x)
155 dma_cfg |= DMAFLOW_ARRAY | NDSIZE_5 | RESTART | WDSIZE_32 | DMAEN;
157 struct scatterlist *sg;
159 for_each_sg(data->sg, sg, host->dma_len, i) {
160 host->sg_cpu[i].start_addr = sg_dma_address(sg);
161 host->sg_cpu[i].cfg = dma_cfg;
162 host->sg_cpu[i].x_count = sg_dma_len(sg) / 4;
163 host->sg_cpu[i].x_modify = 4;
164 dev_dbg(mmc_dev(host->mmc), "%d: start_addr:0x%lx, "
165 "cfg:0x%x, x_count:0x%x, x_modify:0x%x\n",
166 i, host->sg_cpu[i].start_addr,
167 host->sg_cpu[i].cfg, host->sg_cpu[i].x_count,
168 host->sg_cpu[i].x_modify);
171 flush_dcache_range((unsigned int)host->sg_cpu,
172 (unsigned int)host->sg_cpu +
173 host->dma_len * sizeof(struct dma_desc_array));
174 /* Set the last descriptor to stop mode */
175 host->sg_cpu[host->dma_len - 1].cfg &= ~(DMAFLOW | NDSIZE);
176 host->sg_cpu[host->dma_len - 1].cfg |= DI_EN;
178 set_dma_curr_desc_addr(host->dma_ch, (unsigned long *)host->sg_dma);
179 set_dma_x_count(host->dma_ch, 0);
180 set_dma_x_modify(host->dma_ch, 0);
181 set_dma_config(host->dma_ch, dma_cfg);
182 #elif defined(CONFIG_BF51x)
183 /* RSI DMA doesn't work in array mode */
184 dma_cfg |= WDSIZE_32 | DMAEN;
185 set_dma_start_addr(host->dma_ch, sg_dma_address(&data->sg[0]));
186 set_dma_x_count(host->dma_ch, length / 4);
187 set_dma_x_modify(host->dma_ch, 4);
188 set_dma_config(host->dma_ch, dma_cfg);
190 bfin_write_SDH_DATA_CTL(bfin_read_SDH_DATA_CTL() | DTX_DMA_E | DTX_E);
194 dev_dbg(mmc_dev(host->mmc), "%s exit\n", __func__);
198 static void sdh_start_cmd(struct sdh_host *host, struct mmc_command *cmd)
200 unsigned int sdh_cmd;
201 unsigned int stat_mask;
203 dev_dbg(mmc_dev(host->mmc), "%s enter cmd: 0x%p\n", __func__, cmd);
204 WARN_ON(host->cmd != NULL);
210 sdh_cmd |= cmd->opcode;
212 if (cmd->flags & MMC_RSP_PRESENT) {
214 stat_mask |= CMD_RESP_END;
216 stat_mask |= CMD_SENT;
219 if (cmd->flags & MMC_RSP_136)
220 sdh_cmd |= CMD_L_RSP;
222 stat_mask |= CMD_CRC_FAIL | CMD_TIME_OUT;
224 sdh_enable_stat_irq(host, stat_mask);
226 bfin_write_SDH_ARGUMENT(cmd->arg);
227 bfin_write_SDH_COMMAND(sdh_cmd | CMD_E);
228 bfin_write_SDH_CLK_CTL(bfin_read_SDH_CLK_CTL() | CLK_E);
232 static void sdh_finish_request(struct sdh_host *host, struct mmc_request *mrq)
234 dev_dbg(mmc_dev(host->mmc), "%s enter\n", __func__);
238 mmc_request_done(host->mmc, mrq);
241 static int sdh_cmd_done(struct sdh_host *host, unsigned int stat)
243 struct mmc_command *cmd = host->cmd;
246 dev_dbg(mmc_dev(host->mmc), "%s enter cmd: %p\n", __func__, cmd);
252 if (cmd->flags & MMC_RSP_PRESENT) {
253 cmd->resp[0] = bfin_read_SDH_RESPONSE0();
254 if (cmd->flags & MMC_RSP_136) {
255 cmd->resp[1] = bfin_read_SDH_RESPONSE1();
256 cmd->resp[2] = bfin_read_SDH_RESPONSE2();
257 cmd->resp[3] = bfin_read_SDH_RESPONSE3();
260 if (stat & CMD_TIME_OUT)
261 cmd->error = -ETIMEDOUT;
262 else if (stat & CMD_CRC_FAIL && cmd->flags & MMC_RSP_CRC)
263 cmd->error = -EILSEQ;
265 sdh_disable_stat_irq(host, (CMD_SENT | CMD_RESP_END | CMD_TIME_OUT | CMD_CRC_FAIL));
267 if (host->data && !cmd->error) {
268 if (host->data->flags & MMC_DATA_WRITE) {
269 ret = sdh_setup_data(host, host->data);
274 sdh_enable_stat_irq(host, DAT_END | RX_OVERRUN | TX_UNDERRUN | DAT_TIME_OUT);
276 sdh_finish_request(host, host->mrq);
281 static int sdh_data_done(struct sdh_host *host, unsigned int stat)
283 struct mmc_data *data = host->data;
285 dev_dbg(mmc_dev(host->mmc), "%s enter stat: 0x%x\n", __func__, stat);
289 disable_dma(host->dma_ch);
290 dma_unmap_sg(mmc_dev(host->mmc), data->sg, data->sg_len,
293 if (stat & DAT_TIME_OUT)
294 data->error = -ETIMEDOUT;
295 else if (stat & DAT_CRC_FAIL)
296 data->error = -EILSEQ;
297 else if (stat & (RX_OVERRUN | TX_UNDERRUN))
301 data->bytes_xfered = data->blocks * data->blksz;
303 data->bytes_xfered = 0;
305 sdh_disable_stat_irq(host, DAT_END | DAT_TIME_OUT | DAT_CRC_FAIL | RX_OVERRUN | TX_UNDERRUN);
306 bfin_write_SDH_STATUS_CLR(DAT_END_STAT | DAT_TIMEOUT_STAT | \
307 DAT_CRC_FAIL_STAT | DAT_BLK_END_STAT | RX_OVERRUN | TX_UNDERRUN);
308 bfin_write_SDH_DATA_CTL(0);
312 if (host->mrq->stop) {
313 sdh_stop_clock(host);
314 sdh_start_cmd(host, host->mrq->stop);
316 sdh_finish_request(host, host->mrq);
322 static void sdh_request(struct mmc_host *mmc, struct mmc_request *mrq)
324 struct sdh_host *host = mmc_priv(mmc);
327 dev_dbg(mmc_dev(host->mmc), "%s enter, mrp:%p, cmd:%p\n", __func__, mrq, mrq->cmd);
328 WARN_ON(host->mrq != NULL);
331 host->data = mrq->data;
333 if (mrq->data && mrq->data->flags & MMC_DATA_READ) {
334 ret = sdh_setup_data(host, mrq->data);
339 sdh_start_cmd(host, mrq->cmd);
342 static void sdh_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
344 struct sdh_host *host;
349 host = mmc_priv(mmc);
351 spin_lock_irqsave(&host->lock, flags);
353 unsigned long sys_clk, ios_clk;
354 unsigned char clk_div;
355 ios_clk = 2 * ios->clock;
356 sys_clk = get_sclk();
357 clk_div = sys_clk / ios_clk;
358 if (sys_clk % ios_clk == 0)
360 clk_div = min_t(unsigned char, clk_div, 0xFF);
363 host->clk_div = clk_div;
365 sdh_stop_clock(host);
367 if (ios->bus_mode == MMC_BUSMODE_OPENDRAIN)
368 #ifdef CONFIG_SDH_BFIN_MISSING_CMD_PULLUP_WORKAROUND
371 pwr_ctl |= SD_CMD_OD | ROD_CTL;
374 if (ios->bus_width == MMC_BUS_WIDTH_4) {
375 cfg = bfin_read_SDH_CFG();
378 /* Enable 4 bit SDIO */
380 bfin_write_SDH_CFG(cfg);
383 cfg = bfin_read_SDH_CFG();
385 bfin_write_SDH_CFG(cfg);
388 bfin_write_SDH_CLK_CTL(clk_ctl);
390 host->power_mode = ios->power_mode;
391 if (ios->power_mode == MMC_POWER_ON)
394 bfin_write_SDH_PWR_CTL(pwr_ctl);
397 spin_unlock_irqrestore(&host->lock, flags);
399 dev_dbg(mmc_dev(host->mmc), "SDH: clk_div = 0x%x actual clock:%ld expected clock:%d\n",
401 host->clk_div ? get_sclk() / (2 * (host->clk_div + 1)) : 0,
405 static const struct mmc_host_ops sdh_ops = {
406 .request = sdh_request,
407 .set_ios = sdh_set_ios,
410 static irqreturn_t sdh_dma_irq(int irq, void *devid)
412 struct sdh_host *host = devid;
414 dev_dbg(mmc_dev(host->mmc), "%s enter, irq_stat: 0x%04x\n", __func__,
415 get_dma_curr_irqstat(host->dma_ch));
416 clear_dma_irqstat(host->dma_ch);
422 static irqreturn_t sdh_stat_irq(int irq, void *devid)
424 struct sdh_host *host = devid;
428 dev_dbg(mmc_dev(host->mmc), "%s enter\n", __func__);
429 status = bfin_read_SDH_E_STATUS();
430 if (status & SD_CARD_DET) {
431 mmc_detect_change(host->mmc, 0);
432 bfin_write_SDH_E_STATUS(SD_CARD_DET);
434 status = bfin_read_SDH_STATUS();
435 if (status & (CMD_SENT | CMD_RESP_END | CMD_TIME_OUT | CMD_CRC_FAIL)) {
436 handled |= sdh_cmd_done(host, status);
437 bfin_write_SDH_STATUS_CLR(CMD_SENT_STAT | CMD_RESP_END_STAT | \
438 CMD_TIMEOUT_STAT | CMD_CRC_FAIL_STAT);
442 status = bfin_read_SDH_STATUS();
443 if (status & (DAT_END | DAT_TIME_OUT | DAT_CRC_FAIL | RX_OVERRUN | TX_UNDERRUN))
444 handled |= sdh_data_done(host, status);
446 dev_dbg(mmc_dev(host->mmc), "%s exit\n\n", __func__);
448 return IRQ_RETVAL(handled);
451 static int __devinit sdh_probe(struct platform_device *pdev)
453 struct mmc_host *mmc;
454 struct sdh_host *host;
455 struct bfin_sd_host *drv_data = get_sdh_data(pdev);
459 dev_err(&pdev->dev, "missing platform driver data\n");
464 mmc = mmc_alloc_host(sizeof(*mmc), &pdev->dev);
471 mmc->max_phys_segs = 32;
472 mmc->max_seg_size = 1 << 16;
473 mmc->max_blk_size = 1 << 11;
474 mmc->max_blk_count = 1 << 11;
475 mmc->max_req_size = PAGE_SIZE;
476 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
477 mmc->f_max = get_sclk();
478 mmc->f_min = mmc->f_max >> 9;
479 mmc->caps = MMC_CAP_4_BIT_DATA | MMC_CAP_NEEDS_POLL;
480 host = mmc_priv(mmc);
483 spin_lock_init(&host->lock);
484 host->irq = drv_data->irq_int0;
485 host->dma_ch = drv_data->dma_chan;
487 ret = request_dma(host->dma_ch, DRIVER_NAME "DMA");
489 dev_err(&pdev->dev, "unable to request DMA channel\n");
493 ret = set_dma_callback(host->dma_ch, sdh_dma_irq, host);
495 dev_err(&pdev->dev, "unable to request DMA irq\n");
499 host->sg_cpu = dma_alloc_coherent(&pdev->dev, PAGE_SIZE, &host->sg_dma, GFP_KERNEL);
500 if (host->sg_cpu == NULL) {
505 platform_set_drvdata(pdev, mmc);
508 ret = request_irq(host->irq, sdh_stat_irq, 0, "SDH Status IRQ", host);
510 dev_err(&pdev->dev, "unable to request status irq\n");
514 ret = peripheral_request_list(drv_data->pin_req, DRIVER_NAME);
516 dev_err(&pdev->dev, "unable to request peripheral pins\n");
519 #if defined(CONFIG_BF54x)
520 /* Secure Digital Host shares DMA with Nand controller */
521 bfin_write_DMAC1_PERIMUX(bfin_read_DMAC1_PERIMUX() | 0x1);
524 bfin_write_SDH_CFG(bfin_read_SDH_CFG() | CLKS_EN);
527 /* Disable card inserting detection pin. set MMC_CAP_NEES_POLL, and
528 * mmc stack will do the detection.
530 bfin_write_SDH_CFG((bfin_read_SDH_CFG() & 0x1F) | (PUP_SDDAT | PUP_SDDAT3));
536 free_irq(host->irq, host);
538 mmc_remove_host(mmc);
539 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
541 free_dma(host->dma_ch);
548 static int __devexit sdh_remove(struct platform_device *pdev)
550 struct mmc_host *mmc = platform_get_drvdata(pdev);
552 platform_set_drvdata(pdev, NULL);
555 struct sdh_host *host = mmc_priv(mmc);
557 mmc_remove_host(mmc);
559 sdh_stop_clock(host);
560 free_irq(host->irq, host);
561 free_dma(host->dma_ch);
562 dma_free_coherent(&pdev->dev, PAGE_SIZE, host->sg_cpu, host->sg_dma);
571 static int sdh_suspend(struct platform_device *dev, pm_message_t state)
573 struct mmc_host *mmc = platform_get_drvdata(dev);
574 struct bfin_sd_host *drv_data = get_sdh_data(dev);
578 ret = mmc_suspend_host(mmc, state);
580 bfin_write_SDH_PWR_CTL(bfin_read_SDH_PWR_CTL() & ~PWR_ON);
581 peripheral_free_list(drv_data->pin_req);
586 static int sdh_resume(struct platform_device *dev)
588 struct mmc_host *mmc = platform_get_drvdata(dev);
589 struct bfin_sd_host *drv_data = get_sdh_data(dev);
592 ret = peripheral_request_list(drv_data->pin_req, DRIVER_NAME);
594 dev_err(&dev->dev, "unable to request peripheral pins\n");
598 bfin_write_SDH_PWR_CTL(bfin_read_SDH_PWR_CTL() | PWR_ON);
599 #if defined(CONFIG_BF54x)
600 /* Secure Digital Host shares DMA with Nand controller */
601 bfin_write_DMAC1_PERIMUX(bfin_read_DMAC1_PERIMUX() | 0x1);
603 bfin_write_SDH_CFG(bfin_read_SDH_CFG() | CLKS_EN);
606 bfin_write_SDH_CFG((bfin_read_SDH_CFG() & 0x1F) | (PUP_SDDAT | PUP_SDDAT3));
610 ret = mmc_resume_host(mmc);
615 # define sdh_suspend NULL
616 # define sdh_resume NULL
619 static struct platform_driver sdh_driver = {
621 .remove = __devexit_p(sdh_remove),
622 .suspend = sdh_suspend,
623 .resume = sdh_resume,
629 static int __init sdh_init(void)
631 return platform_driver_register(&sdh_driver);
633 module_init(sdh_init);
635 static void __exit sdh_exit(void)
637 platform_driver_unregister(&sdh_driver);
639 module_exit(sdh_exit);
641 MODULE_DESCRIPTION("Blackfin Secure Digital Host Driver");
642 MODULE_AUTHOR("Cliff Cai, Roy Huang");
643 MODULE_LICENSE("GPL");