1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Actions Semi Owl SoCs SD/MMC driver
5 * Copyright (c) 2014 Actions Semi Inc.
11 #include <linux/clk.h>
12 #include <linux/delay.h>
13 #include <linux/dmaengine.h>
14 #include <linux/dma-direction.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/interrupt.h>
17 #include <linux/mmc/host.h>
18 #include <linux/mmc/slot-gpio.h>
19 #include <linux/module.h>
20 #include <linux/of_platform.h>
21 #include <linux/reset.h>
22 #include <linux/spinlock.h>
27 #define OWL_REG_SD_EN 0x0000
28 #define OWL_REG_SD_CTL 0x0004
29 #define OWL_REG_SD_STATE 0x0008
30 #define OWL_REG_SD_CMD 0x000c
31 #define OWL_REG_SD_ARG 0x0010
32 #define OWL_REG_SD_RSPBUF0 0x0014
33 #define OWL_REG_SD_RSPBUF1 0x0018
34 #define OWL_REG_SD_RSPBUF2 0x001c
35 #define OWL_REG_SD_RSPBUF3 0x0020
36 #define OWL_REG_SD_RSPBUF4 0x0024
37 #define OWL_REG_SD_DAT 0x0028
38 #define OWL_REG_SD_BLK_SIZE 0x002c
39 #define OWL_REG_SD_BLK_NUM 0x0030
40 #define OWL_REG_SD_BUF_SIZE 0x0034
43 #define OWL_SD_EN_RANE BIT(31)
44 #define OWL_SD_EN_RAN_SEED(x) (((x) & 0x3f) << 24)
45 #define OWL_SD_EN_S18EN BIT(12)
46 #define OWL_SD_EN_RESE BIT(10)
47 #define OWL_SD_EN_DAT1_S BIT(9)
48 #define OWL_SD_EN_CLK_S BIT(8)
49 #define OWL_SD_ENABLE BIT(7)
50 #define OWL_SD_EN_BSEL BIT(6)
51 #define OWL_SD_EN_SDIOEN BIT(3)
52 #define OWL_SD_EN_DDREN BIT(2)
53 #define OWL_SD_EN_DATAWID(x) (((x) & 0x3) << 0)
56 #define OWL_SD_CTL_TOUTEN BIT(31)
57 #define OWL_SD_CTL_TOUTCNT(x) (((x) & 0x7f) << 24)
58 #define OWL_SD_CTL_DELAY_MSK GENMASK(23, 16)
59 #define OWL_SD_CTL_RDELAY(x) (((x) & 0xf) << 20)
60 #define OWL_SD_CTL_WDELAY(x) (((x) & 0xf) << 16)
61 #define OWL_SD_CTL_CMDLEN BIT(13)
62 #define OWL_SD_CTL_SCC BIT(12)
63 #define OWL_SD_CTL_TCN(x) (((x) & 0xf) << 8)
64 #define OWL_SD_CTL_TS BIT(7)
65 #define OWL_SD_CTL_LBE BIT(6)
66 #define OWL_SD_CTL_C7EN BIT(5)
67 #define OWL_SD_CTL_TM(x) (((x) & 0xf) << 0)
69 #define OWL_SD_DELAY_LOW_CLK 0x0f
70 #define OWL_SD_DELAY_MID_CLK 0x0a
71 #define OWL_SD_DELAY_HIGH_CLK 0x09
72 #define OWL_SD_RDELAY_DDR50 0x0a
73 #define OWL_SD_WDELAY_DDR50 0x08
76 #define OWL_SD_STATE_DAT1BS BIT(18)
77 #define OWL_SD_STATE_SDIOB_P BIT(17)
78 #define OWL_SD_STATE_SDIOB_EN BIT(16)
79 #define OWL_SD_STATE_TOUTE BIT(15)
80 #define OWL_SD_STATE_BAEP BIT(14)
81 #define OWL_SD_STATE_MEMRDY BIT(12)
82 #define OWL_SD_STATE_CMDS BIT(11)
83 #define OWL_SD_STATE_DAT1AS BIT(10)
84 #define OWL_SD_STATE_SDIOA_P BIT(9)
85 #define OWL_SD_STATE_SDIOA_EN BIT(8)
86 #define OWL_SD_STATE_DAT0S BIT(7)
87 #define OWL_SD_STATE_TEIE BIT(6)
88 #define OWL_SD_STATE_TEI BIT(5)
89 #define OWL_SD_STATE_CLNR BIT(4)
90 #define OWL_SD_STATE_CLC BIT(3)
91 #define OWL_SD_STATE_WC16ER BIT(2)
92 #define OWL_SD_STATE_RC16ER BIT(1)
93 #define OWL_SD_STATE_CRC7ER BIT(0)
95 #define OWL_CMD_TIMEOUT_MS 30000
99 struct reset_control *reset;
102 struct completion sdc_complete;
108 enum dma_data_direction dma_dir;
109 struct dma_chan *dma;
110 struct dma_async_tx_descriptor *desc;
111 struct dma_slave_config dma_cfg;
112 struct completion dma_complete;
114 struct mmc_host *mmc;
115 struct mmc_request *mrq;
116 struct mmc_command *cmd;
117 struct mmc_data *data;
120 static void owl_mmc_update_reg(void __iomem *reg, unsigned int val, bool state)
134 static irqreturn_t owl_irq_handler(int irq, void *devid)
136 struct owl_mmc_host *owl_host = devid;
139 spin_lock(&owl_host->lock);
141 state = readl(owl_host->base + OWL_REG_SD_STATE);
142 if (state & OWL_SD_STATE_TEI) {
143 state = readl(owl_host->base + OWL_REG_SD_STATE);
144 state |= OWL_SD_STATE_TEI;
145 writel(state, owl_host->base + OWL_REG_SD_STATE);
146 complete(&owl_host->sdc_complete);
149 spin_unlock(&owl_host->lock);
154 static void owl_mmc_finish_request(struct owl_mmc_host *owl_host)
156 struct mmc_request *mrq = owl_host->mrq;
157 struct mmc_data *data = mrq->data;
159 /* Should never be NULL */
162 owl_host->mrq = NULL;
165 dma_unmap_sg(owl_host->dma->device->dev, data->sg, data->sg_len,
168 /* Finally finish request */
169 mmc_request_done(owl_host->mmc, mrq);
172 static void owl_mmc_send_cmd(struct owl_mmc_host *owl_host,
173 struct mmc_command *cmd,
174 struct mmc_data *data)
176 unsigned long timeout;
177 u32 mode, state, resp[2];
178 u32 cmd_rsp_mask = 0;
180 init_completion(&owl_host->sdc_complete);
182 switch (mmc_resp_type(cmd)) {
184 mode = OWL_SD_CTL_TM(0);
189 if (data->flags & MMC_DATA_READ)
190 mode = OWL_SD_CTL_TM(4);
192 mode = OWL_SD_CTL_TM(5);
194 mode = OWL_SD_CTL_TM(1);
196 cmd_rsp_mask = OWL_SD_STATE_CLNR | OWL_SD_STATE_CRC7ER;
201 mode = OWL_SD_CTL_TM(3);
202 cmd_rsp_mask = OWL_SD_STATE_CLNR | OWL_SD_STATE_CRC7ER;
206 mode = OWL_SD_CTL_TM(2);
207 cmd_rsp_mask = OWL_SD_STATE_CLNR | OWL_SD_STATE_CRC7ER;
211 mode = OWL_SD_CTL_TM(1);
212 cmd_rsp_mask = OWL_SD_STATE_CLNR;
216 dev_warn(owl_host->dev, "Unknown MMC command\n");
217 cmd->error = -EINVAL;
221 /* Keep current WDELAY and RDELAY */
222 mode |= (readl(owl_host->base + OWL_REG_SD_CTL) & (0xff << 16));
224 /* Start to send corresponding command type */
225 writel(cmd->arg, owl_host->base + OWL_REG_SD_ARG);
226 writel(cmd->opcode, owl_host->base + OWL_REG_SD_CMD);
228 /* Set LBE to send clk at the end of last read block */
230 mode |= (OWL_SD_CTL_TS | OWL_SD_CTL_LBE | 0x64000000);
232 mode &= ~(OWL_SD_CTL_TOUTEN | OWL_SD_CTL_LBE);
233 mode |= OWL_SD_CTL_TS;
239 writel(mode, owl_host->base + OWL_REG_SD_CTL);
244 timeout = msecs_to_jiffies(cmd->busy_timeout ? cmd->busy_timeout :
247 if (!wait_for_completion_timeout(&owl_host->sdc_complete, timeout)) {
248 dev_err(owl_host->dev, "CMD interrupt timeout\n");
249 cmd->error = -ETIMEDOUT;
253 state = readl(owl_host->base + OWL_REG_SD_STATE);
254 if (mmc_resp_type(cmd) & MMC_RSP_PRESENT) {
255 if (cmd_rsp_mask & state) {
256 if (state & OWL_SD_STATE_CLNR) {
257 dev_err(owl_host->dev, "Error CMD_NO_RSP\n");
258 cmd->error = -EILSEQ;
262 if (state & OWL_SD_STATE_CRC7ER) {
263 dev_err(owl_host->dev, "Error CMD_RSP_CRC\n");
264 cmd->error = -EILSEQ;
269 if (mmc_resp_type(cmd) & MMC_RSP_136) {
270 cmd->resp[3] = readl(owl_host->base + OWL_REG_SD_RSPBUF0);
271 cmd->resp[2] = readl(owl_host->base + OWL_REG_SD_RSPBUF1);
272 cmd->resp[1] = readl(owl_host->base + OWL_REG_SD_RSPBUF2);
273 cmd->resp[0] = readl(owl_host->base + OWL_REG_SD_RSPBUF3);
275 resp[0] = readl(owl_host->base + OWL_REG_SD_RSPBUF0);
276 resp[1] = readl(owl_host->base + OWL_REG_SD_RSPBUF1);
277 cmd->resp[0] = resp[1] << 24 | resp[0] >> 8;
278 cmd->resp[1] = resp[1] >> 8;
283 static void owl_mmc_dma_complete(void *param)
285 struct owl_mmc_host *owl_host = param;
286 struct mmc_data *data = owl_host->data;
289 complete(&owl_host->dma_complete);
292 static int owl_mmc_prepare_data(struct owl_mmc_host *owl_host,
293 struct mmc_data *data)
297 owl_mmc_update_reg(owl_host->base + OWL_REG_SD_EN, OWL_SD_EN_BSEL,
299 writel(data->blocks, owl_host->base + OWL_REG_SD_BLK_NUM);
300 writel(data->blksz, owl_host->base + OWL_REG_SD_BLK_SIZE);
301 total = data->blksz * data->blocks;
304 writel(total, owl_host->base + OWL_REG_SD_BUF_SIZE);
306 writel(512, owl_host->base + OWL_REG_SD_BUF_SIZE);
308 if (data->flags & MMC_DATA_WRITE) {
309 owl_host->dma_dir = DMA_TO_DEVICE;
310 owl_host->dma_cfg.direction = DMA_MEM_TO_DEV;
312 owl_host->dma_dir = DMA_FROM_DEVICE;
313 owl_host->dma_cfg.direction = DMA_DEV_TO_MEM;
316 dma_map_sg(owl_host->dma->device->dev, data->sg,
317 data->sg_len, owl_host->dma_dir);
319 dmaengine_slave_config(owl_host->dma, &owl_host->dma_cfg);
320 owl_host->desc = dmaengine_prep_slave_sg(owl_host->dma, data->sg,
322 owl_host->dma_cfg.direction,
325 if (!owl_host->desc) {
326 dev_err(owl_host->dev, "Can't prepare slave sg\n");
330 owl_host->data = data;
332 owl_host->desc->callback = owl_mmc_dma_complete;
333 owl_host->desc->callback_param = (void *)owl_host;
339 static void owl_mmc_request(struct mmc_host *mmc, struct mmc_request *mrq)
341 struct owl_mmc_host *owl_host = mmc_priv(mmc);
342 struct mmc_data *data = mrq->data;
347 ret = owl_mmc_prepare_data(owl_host, data);
353 init_completion(&owl_host->dma_complete);
354 dmaengine_submit(owl_host->desc);
355 dma_async_issue_pending(owl_host->dma);
358 owl_mmc_send_cmd(owl_host, mrq->cmd, data);
361 if (!wait_for_completion_timeout(&owl_host->sdc_complete,
363 dev_err(owl_host->dev, "CMD interrupt timeout\n");
364 mrq->cmd->error = -ETIMEDOUT;
365 dmaengine_terminate_all(owl_host->dma);
369 if (!wait_for_completion_timeout(&owl_host->dma_complete,
371 dev_err(owl_host->dev, "DMA interrupt timeout\n");
372 mrq->cmd->error = -ETIMEDOUT;
373 dmaengine_terminate_all(owl_host->dma);
378 owl_mmc_send_cmd(owl_host, data->stop, NULL);
380 data->bytes_xfered = data->blocks * data->blksz;
384 owl_mmc_finish_request(owl_host);
387 static int owl_mmc_set_clk_rate(struct owl_mmc_host *owl_host,
390 unsigned long clk_rate;
394 reg = readl(owl_host->base + OWL_REG_SD_CTL);
395 reg &= ~OWL_SD_CTL_DELAY_MSK;
397 /* Set RDELAY and WDELAY based on the clock */
398 if (rate <= 1000000) {
399 writel(reg | OWL_SD_CTL_RDELAY(OWL_SD_DELAY_LOW_CLK) |
400 OWL_SD_CTL_WDELAY(OWL_SD_DELAY_LOW_CLK),
401 owl_host->base + OWL_REG_SD_CTL);
402 } else if ((rate > 1000000) && (rate <= 26000000)) {
403 writel(reg | OWL_SD_CTL_RDELAY(OWL_SD_DELAY_MID_CLK) |
404 OWL_SD_CTL_WDELAY(OWL_SD_DELAY_MID_CLK),
405 owl_host->base + OWL_REG_SD_CTL);
406 } else if ((rate > 26000000) && (rate <= 52000000) && !owl_host->ddr_50) {
407 writel(reg | OWL_SD_CTL_RDELAY(OWL_SD_DELAY_HIGH_CLK) |
408 OWL_SD_CTL_WDELAY(OWL_SD_DELAY_HIGH_CLK),
409 owl_host->base + OWL_REG_SD_CTL);
410 /* DDR50 mode has special delay chain */
411 } else if ((rate > 26000000) && (rate <= 52000000) && owl_host->ddr_50) {
412 writel(reg | OWL_SD_CTL_RDELAY(OWL_SD_RDELAY_DDR50) |
413 OWL_SD_CTL_WDELAY(OWL_SD_WDELAY_DDR50),
414 owl_host->base + OWL_REG_SD_CTL);
416 dev_err(owl_host->dev, "SD clock rate not supported\n");
420 clk_rate = clk_round_rate(owl_host->clk, rate << 1);
421 ret = clk_set_rate(owl_host->clk, clk_rate);
426 static void owl_mmc_set_clk(struct owl_mmc_host *owl_host, struct mmc_ios *ios)
431 owl_host->clock = ios->clock;
432 owl_mmc_set_clk_rate(owl_host, ios->clock);
435 static void owl_mmc_set_bus_width(struct owl_mmc_host *owl_host,
440 reg = readl(owl_host->base + OWL_REG_SD_EN);
442 switch (ios->bus_width) {
443 case MMC_BUS_WIDTH_1:
445 case MMC_BUS_WIDTH_4:
446 reg |= OWL_SD_EN_DATAWID(1);
448 case MMC_BUS_WIDTH_8:
449 reg |= OWL_SD_EN_DATAWID(2);
453 writel(reg, owl_host->base + OWL_REG_SD_EN);
456 static void owl_mmc_ctr_reset(struct owl_mmc_host *owl_host)
458 reset_control_assert(owl_host->reset);
460 reset_control_deassert(owl_host->reset);
463 static void owl_mmc_power_on(struct owl_mmc_host *owl_host)
467 init_completion(&owl_host->sdc_complete);
469 /* Enable transfer end IRQ */
470 owl_mmc_update_reg(owl_host->base + OWL_REG_SD_STATE,
471 OWL_SD_STATE_TEIE, true);
474 mode = (readl(owl_host->base + OWL_REG_SD_CTL) & (0xff << 16));
475 mode |= OWL_SD_CTL_TS | OWL_SD_CTL_TCN(5) | OWL_SD_CTL_TM(8);
476 writel(mode, owl_host->base + OWL_REG_SD_CTL);
478 if (!wait_for_completion_timeout(&owl_host->sdc_complete, HZ)) {
479 dev_err(owl_host->dev, "CMD interrupt timeout\n");
484 static void owl_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
486 struct owl_mmc_host *owl_host = mmc_priv(mmc);
488 switch (ios->power_mode) {
490 dev_dbg(owl_host->dev, "Powering card up\n");
492 /* Reset the SDC controller to clear all previous states */
493 owl_mmc_ctr_reset(owl_host);
494 clk_prepare_enable(owl_host->clk);
495 writel(OWL_SD_ENABLE | OWL_SD_EN_RESE,
496 owl_host->base + OWL_REG_SD_EN);
501 dev_dbg(owl_host->dev, "Powering card on\n");
502 owl_mmc_power_on(owl_host);
507 dev_dbg(owl_host->dev, "Powering card off\n");
508 clk_disable_unprepare(owl_host->clk);
513 dev_dbg(owl_host->dev, "Ignoring unknown card power state\n");
517 if (ios->clock != owl_host->clock)
518 owl_mmc_set_clk(owl_host, ios);
520 owl_mmc_set_bus_width(owl_host, ios);
522 /* Enable DDR mode if requested */
523 if (ios->timing == MMC_TIMING_UHS_DDR50) {
524 owl_host->ddr_50 = true;
525 owl_mmc_update_reg(owl_host->base + OWL_REG_SD_EN,
526 OWL_SD_EN_DDREN, true);
528 owl_host->ddr_50 = false;
532 static int owl_mmc_start_signal_voltage_switch(struct mmc_host *mmc,
535 struct owl_mmc_host *owl_host = mmc_priv(mmc);
537 /* It is enough to change the pad ctrl bit for voltage switch */
538 switch (ios->signal_voltage) {
539 case MMC_SIGNAL_VOLTAGE_330:
540 owl_mmc_update_reg(owl_host->base + OWL_REG_SD_EN,
541 OWL_SD_EN_S18EN, false);
543 case MMC_SIGNAL_VOLTAGE_180:
544 owl_mmc_update_reg(owl_host->base + OWL_REG_SD_EN,
545 OWL_SD_EN_S18EN, true);
554 static const struct mmc_host_ops owl_mmc_ops = {
555 .request = owl_mmc_request,
556 .set_ios = owl_mmc_set_ios,
557 .get_ro = mmc_gpio_get_ro,
558 .get_cd = mmc_gpio_get_cd,
559 .start_signal_voltage_switch = owl_mmc_start_signal_voltage_switch,
562 static int owl_mmc_probe(struct platform_device *pdev)
564 struct owl_mmc_host *owl_host;
565 struct mmc_host *mmc;
566 struct resource *res;
569 mmc = mmc_alloc_host(sizeof(struct owl_mmc_host), &pdev->dev);
571 dev_err(&pdev->dev, "mmc alloc host failed\n");
574 platform_set_drvdata(pdev, mmc);
576 owl_host = mmc_priv(mmc);
577 owl_host->dev = &pdev->dev;
579 spin_lock_init(&owl_host->lock);
581 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
582 owl_host->base = devm_ioremap_resource(&pdev->dev, res);
583 if (IS_ERR(owl_host->base)) {
584 ret = PTR_ERR(owl_host->base);
588 owl_host->clk = devm_clk_get(&pdev->dev, NULL);
589 if (IS_ERR(owl_host->clk)) {
590 dev_err(&pdev->dev, "No clock defined\n");
591 ret = PTR_ERR(owl_host->clk);
595 owl_host->reset = devm_reset_control_get_exclusive(&pdev->dev, NULL);
596 if (IS_ERR(owl_host->reset)) {
597 dev_err(&pdev->dev, "Could not get reset control\n");
598 ret = PTR_ERR(owl_host->reset);
602 mmc->ops = &owl_mmc_ops;
603 mmc->max_blk_count = 512;
604 mmc->max_blk_size = 512;
606 mmc->max_seg_size = 262144;
607 mmc->max_req_size = 262144;
610 mmc->f_max = 52000000;
611 mmc->caps |= MMC_CAP_MMC_HIGHSPEED | MMC_CAP_SD_HIGHSPEED |
613 mmc->caps2 = (MMC_CAP2_BOOTPART_NOACC | MMC_CAP2_NO_SDIO);
614 mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34 |
617 ret = mmc_of_parse(mmc);
621 pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
622 pdev->dev.dma_mask = &pdev->dev.coherent_dma_mask;
623 owl_host->dma = dma_request_chan(&pdev->dev, "mmc");
624 if (IS_ERR(owl_host->dma)) {
625 dev_err(owl_host->dev, "Failed to get external DMA channel.\n");
626 ret = PTR_ERR(owl_host->dma);
630 dev_info(&pdev->dev, "Using %s for DMA transfers\n",
631 dma_chan_name(owl_host->dma));
633 owl_host->dma_cfg.src_addr = res->start + OWL_REG_SD_DAT;
634 owl_host->dma_cfg.dst_addr = res->start + OWL_REG_SD_DAT;
635 owl_host->dma_cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
636 owl_host->dma_cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
637 owl_host->dma_cfg.device_fc = false;
639 owl_host->irq = platform_get_irq(pdev, 0);
640 if (owl_host->irq < 0) {
642 goto err_release_channel;
645 ret = devm_request_irq(&pdev->dev, owl_host->irq, owl_irq_handler,
646 0, dev_name(&pdev->dev), owl_host);
648 dev_err(&pdev->dev, "Failed to request irq %d\n",
650 goto err_release_channel;
653 ret = mmc_add_host(mmc);
655 dev_err(&pdev->dev, "Failed to add host\n");
656 goto err_release_channel;
659 dev_dbg(&pdev->dev, "Owl MMC Controller Initialized\n");
664 dma_release_channel(owl_host->dma);
671 static int owl_mmc_remove(struct platform_device *pdev)
673 struct mmc_host *mmc = platform_get_drvdata(pdev);
674 struct owl_mmc_host *owl_host = mmc_priv(mmc);
676 mmc_remove_host(mmc);
677 disable_irq(owl_host->irq);
678 dma_release_channel(owl_host->dma);
684 static const struct of_device_id owl_mmc_of_match[] = {
685 {.compatible = "actions,owl-mmc",},
688 MODULE_DEVICE_TABLE(of, owl_mmc_of_match);
690 static struct platform_driver owl_mmc_driver = {
693 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
694 .of_match_table = owl_mmc_of_match,
696 .probe = owl_mmc_probe,
697 .remove = owl_mmc_remove,
699 module_platform_driver(owl_mmc_driver);
701 MODULE_DESCRIPTION("Actions Semi Owl SoCs SD/MMC Driver");
702 MODULE_AUTHOR("Actions Semi");
704 MODULE_LICENSE("GPL");