1 // SPDX-License-Identifier: GPL-2.0-only
3 * Amlogic SD/eMMC driver for the GX/S905 family SoCs
5 * Copyright (c) 2016 BayLibre, SAS.
6 * Author: Kevin Hilman <khilman@baylibre.com>
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/init.h>
11 #include <linux/delay.h>
12 #include <linux/device.h>
13 #include <linux/iopoll.h>
14 #include <linux/of_device.h>
15 #include <linux/platform_device.h>
16 #include <linux/ioport.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/mmc/host.h>
19 #include <linux/mmc/mmc.h>
20 #include <linux/mmc/sdio.h>
21 #include <linux/mmc/slot-gpio.h>
23 #include <linux/clk.h>
24 #include <linux/clk-provider.h>
25 #include <linux/regulator/consumer.h>
26 #include <linux/reset.h>
27 #include <linux/interrupt.h>
28 #include <linux/bitfield.h>
29 #include <linux/pinctrl/consumer.h>
31 #define DRIVER_NAME "meson-gx-mmc"
33 #define SD_EMMC_CLOCK 0x0
34 #define CLK_DIV_MASK GENMASK(5, 0)
35 #define CLK_SRC_MASK GENMASK(7, 6)
36 #define CLK_CORE_PHASE_MASK GENMASK(9, 8)
37 #define CLK_TX_PHASE_MASK GENMASK(11, 10)
38 #define CLK_RX_PHASE_MASK GENMASK(13, 12)
40 #define CLK_PHASE_180 2
41 #define CLK_V2_TX_DELAY_MASK GENMASK(19, 16)
42 #define CLK_V2_RX_DELAY_MASK GENMASK(23, 20)
43 #define CLK_V2_ALWAYS_ON BIT(24)
45 #define CLK_V3_TX_DELAY_MASK GENMASK(21, 16)
46 #define CLK_V3_RX_DELAY_MASK GENMASK(27, 22)
47 #define CLK_V3_ALWAYS_ON BIT(28)
49 #define CLK_TX_DELAY_MASK(h) (h->data->tx_delay_mask)
50 #define CLK_RX_DELAY_MASK(h) (h->data->rx_delay_mask)
51 #define CLK_ALWAYS_ON(h) (h->data->always_on)
53 #define SD_EMMC_DELAY 0x4
54 #define SD_EMMC_ADJUST 0x8
55 #define ADJUST_ADJ_DELAY_MASK GENMASK(21, 16)
56 #define ADJUST_DS_EN BIT(15)
57 #define ADJUST_ADJ_EN BIT(13)
59 #define SD_EMMC_DELAY1 0x4
60 #define SD_EMMC_DELAY2 0x8
61 #define SD_EMMC_V3_ADJUST 0xc
63 #define SD_EMMC_CALOUT 0x10
64 #define SD_EMMC_START 0x40
65 #define START_DESC_INIT BIT(0)
66 #define START_DESC_BUSY BIT(1)
67 #define START_DESC_ADDR_MASK GENMASK(31, 2)
69 #define SD_EMMC_CFG 0x44
70 #define CFG_BUS_WIDTH_MASK GENMASK(1, 0)
71 #define CFG_BUS_WIDTH_1 0x0
72 #define CFG_BUS_WIDTH_4 0x1
73 #define CFG_BUS_WIDTH_8 0x2
74 #define CFG_DDR BIT(2)
75 #define CFG_BLK_LEN_MASK GENMASK(7, 4)
76 #define CFG_RESP_TIMEOUT_MASK GENMASK(11, 8)
77 #define CFG_RC_CC_MASK GENMASK(15, 12)
78 #define CFG_STOP_CLOCK BIT(22)
79 #define CFG_CLK_ALWAYS_ON BIT(18)
80 #define CFG_CHK_DS BIT(20)
81 #define CFG_AUTO_CLK BIT(23)
82 #define CFG_ERR_ABORT BIT(27)
84 #define SD_EMMC_STATUS 0x48
85 #define STATUS_BUSY BIT(31)
86 #define STATUS_DESC_BUSY BIT(30)
87 #define STATUS_DATI GENMASK(23, 16)
89 #define SD_EMMC_IRQ_EN 0x4c
90 #define IRQ_RXD_ERR_MASK GENMASK(7, 0)
91 #define IRQ_TXD_ERR BIT(8)
92 #define IRQ_DESC_ERR BIT(9)
93 #define IRQ_RESP_ERR BIT(10)
95 (IRQ_RXD_ERR_MASK | IRQ_TXD_ERR | IRQ_DESC_ERR | IRQ_RESP_ERR)
96 #define IRQ_RESP_TIMEOUT BIT(11)
97 #define IRQ_DESC_TIMEOUT BIT(12)
98 #define IRQ_TIMEOUTS \
99 (IRQ_RESP_TIMEOUT | IRQ_DESC_TIMEOUT)
100 #define IRQ_END_OF_CHAIN BIT(13)
101 #define IRQ_RESP_STATUS BIT(14)
102 #define IRQ_SDIO BIT(15)
103 #define IRQ_EN_MASK \
104 (IRQ_CRC_ERR | IRQ_TIMEOUTS | IRQ_END_OF_CHAIN | IRQ_RESP_STATUS |\
107 #define SD_EMMC_CMD_CFG 0x50
108 #define SD_EMMC_CMD_ARG 0x54
109 #define SD_EMMC_CMD_DAT 0x58
110 #define SD_EMMC_CMD_RSP 0x5c
111 #define SD_EMMC_CMD_RSP1 0x60
112 #define SD_EMMC_CMD_RSP2 0x64
113 #define SD_EMMC_CMD_RSP3 0x68
115 #define SD_EMMC_RXD 0x94
116 #define SD_EMMC_TXD 0x94
117 #define SD_EMMC_LAST_REG SD_EMMC_TXD
119 #define SD_EMMC_SRAM_DATA_BUF_LEN 1536
120 #define SD_EMMC_SRAM_DATA_BUF_OFF 0x200
122 #define SD_EMMC_CFG_BLK_SIZE 512 /* internal buffer max: 512 bytes */
123 #define SD_EMMC_CFG_RESP_TIMEOUT 256 /* in clock cycles */
124 #define SD_EMMC_CMD_TIMEOUT 1024 /* in ms */
125 #define SD_EMMC_CMD_TIMEOUT_DATA 4096 /* in ms */
126 #define SD_EMMC_CFG_CMD_GAP 16 /* in clock cycles */
127 #define SD_EMMC_DESC_BUF_LEN PAGE_SIZE
129 #define SD_EMMC_PRE_REQ_DONE BIT(0)
130 #define SD_EMMC_DESC_CHAIN_MODE BIT(1)
132 #define MUX_CLK_NUM_PARENTS 2
134 struct meson_mmc_data {
135 unsigned int tx_delay_mask;
136 unsigned int rx_delay_mask;
137 unsigned int always_on;
141 struct sd_emmc_desc {
150 struct meson_mmc_data *data;
151 struct mmc_host *mmc;
152 struct mmc_command *cmd;
155 struct clk *core_clk;
158 unsigned long req_rate;
161 bool dram_access_quirk;
163 struct pinctrl *pinctrl;
164 struct pinctrl_state *pins_clk_gate;
166 unsigned int bounce_buf_size;
168 void __iomem *bounce_iomem_buf;
169 dma_addr_t bounce_dma_addr;
170 struct sd_emmc_desc *descs;
171 dma_addr_t descs_dma_addr;
176 bool needs_pre_post_req;
180 #define CMD_CFG_LENGTH_MASK GENMASK(8, 0)
181 #define CMD_CFG_BLOCK_MODE BIT(9)
182 #define CMD_CFG_R1B BIT(10)
183 #define CMD_CFG_END_OF_CHAIN BIT(11)
184 #define CMD_CFG_TIMEOUT_MASK GENMASK(15, 12)
185 #define CMD_CFG_NO_RESP BIT(16)
186 #define CMD_CFG_NO_CMD BIT(17)
187 #define CMD_CFG_DATA_IO BIT(18)
188 #define CMD_CFG_DATA_WR BIT(19)
189 #define CMD_CFG_RESP_NOCRC BIT(20)
190 #define CMD_CFG_RESP_128 BIT(21)
191 #define CMD_CFG_RESP_NUM BIT(22)
192 #define CMD_CFG_DATA_NUM BIT(23)
193 #define CMD_CFG_CMD_INDEX_MASK GENMASK(29, 24)
194 #define CMD_CFG_ERROR BIT(30)
195 #define CMD_CFG_OWNER BIT(31)
197 #define CMD_DATA_MASK GENMASK(31, 2)
198 #define CMD_DATA_BIG_ENDIAN BIT(1)
199 #define CMD_DATA_SRAM BIT(0)
200 #define CMD_RESP_MASK GENMASK(31, 1)
201 #define CMD_RESP_SRAM BIT(0)
203 static unsigned int meson_mmc_get_timeout_msecs(struct mmc_data *data)
205 unsigned int timeout = data->timeout_ns / NSEC_PER_MSEC;
208 return SD_EMMC_CMD_TIMEOUT_DATA;
210 timeout = roundup_pow_of_two(timeout);
212 return min(timeout, 32768U); /* max. 2^15 ms */
215 static struct mmc_command *meson_mmc_get_next_command(struct mmc_command *cmd)
217 if (cmd->opcode == MMC_SET_BLOCK_COUNT && !cmd->error)
218 return cmd->mrq->cmd;
219 else if (mmc_op_multi(cmd->opcode) &&
220 (!cmd->mrq->sbc || cmd->error || cmd->data->error))
221 return cmd->mrq->stop;
226 static void meson_mmc_get_transfer_mode(struct mmc_host *mmc,
227 struct mmc_request *mrq)
229 struct meson_host *host = mmc_priv(mmc);
230 struct mmc_data *data = mrq->data;
231 struct scatterlist *sg;
233 bool use_desc_chain_mode = true;
236 * When Controller DMA cannot directly access DDR memory, disable
237 * support for Chain Mode to directly use the internal SRAM using
238 * the bounce buffer mode.
240 if (host->dram_access_quirk)
244 * Broken SDIO with AP6255-based WiFi on Khadas VIM Pro has been
245 * reported. For some strange reason this occurs in descriptor
246 * chain mode only. So let's fall back to bounce buffer mode
247 * for command SD_IO_RW_EXTENDED.
249 if (mrq->cmd->opcode == SD_IO_RW_EXTENDED)
252 for_each_sg(data->sg, sg, data->sg_len, i)
253 /* check for 8 byte alignment */
254 if (sg->offset & 7) {
255 WARN_ONCE(1, "unaligned scatterlist buffer\n");
256 use_desc_chain_mode = false;
260 if (use_desc_chain_mode)
261 data->host_cookie |= SD_EMMC_DESC_CHAIN_MODE;
264 static inline bool meson_mmc_desc_chain_mode(const struct mmc_data *data)
266 return data->host_cookie & SD_EMMC_DESC_CHAIN_MODE;
269 static inline bool meson_mmc_bounce_buf_read(const struct mmc_data *data)
271 return data && data->flags & MMC_DATA_READ &&
272 !meson_mmc_desc_chain_mode(data);
275 static void meson_mmc_pre_req(struct mmc_host *mmc, struct mmc_request *mrq)
277 struct mmc_data *data = mrq->data;
282 meson_mmc_get_transfer_mode(mmc, mrq);
283 data->host_cookie |= SD_EMMC_PRE_REQ_DONE;
285 if (!meson_mmc_desc_chain_mode(data))
288 data->sg_count = dma_map_sg(mmc_dev(mmc), data->sg, data->sg_len,
289 mmc_get_dma_dir(data));
291 dev_err(mmc_dev(mmc), "dma_map_sg failed");
294 static void meson_mmc_post_req(struct mmc_host *mmc, struct mmc_request *mrq,
297 struct mmc_data *data = mrq->data;
299 if (data && meson_mmc_desc_chain_mode(data) && data->sg_count)
300 dma_unmap_sg(mmc_dev(mmc), data->sg, data->sg_len,
301 mmc_get_dma_dir(data));
305 * Gating the clock on this controller is tricky. It seems the mmc clock
306 * is also used by the controller. It may crash during some operation if the
307 * clock is stopped. The safest thing to do, whenever possible, is to keep
308 * clock running at stop it at the pad using the pinmux.
310 static void meson_mmc_clk_gate(struct meson_host *host)
314 if (host->pins_clk_gate) {
315 pinctrl_select_state(host->pinctrl, host->pins_clk_gate);
318 * If the pinmux is not provided - default to the classic and
321 cfg = readl(host->regs + SD_EMMC_CFG);
322 cfg |= CFG_STOP_CLOCK;
323 writel(cfg, host->regs + SD_EMMC_CFG);
327 static void meson_mmc_clk_ungate(struct meson_host *host)
331 if (host->pins_clk_gate)
332 pinctrl_select_default_state(host->dev);
334 /* Make sure the clock is not stopped in the controller */
335 cfg = readl(host->regs + SD_EMMC_CFG);
336 cfg &= ~CFG_STOP_CLOCK;
337 writel(cfg, host->regs + SD_EMMC_CFG);
340 static int meson_mmc_clk_set(struct meson_host *host, unsigned long rate,
343 struct mmc_host *mmc = host->mmc;
347 /* Same request - bail-out */
348 if (host->ddr == ddr && host->req_rate == rate)
352 meson_mmc_clk_gate(host);
354 mmc->actual_clock = 0;
356 /* return with clock being stopped */
360 /* Stop the clock during rate change to avoid glitches */
361 cfg = readl(host->regs + SD_EMMC_CFG);
362 cfg |= CFG_STOP_CLOCK;
363 writel(cfg, host->regs + SD_EMMC_CFG);
366 /* DDR modes require higher module clock */
372 writel(cfg, host->regs + SD_EMMC_CFG);
375 ret = clk_set_rate(host->mmc_clk, rate);
377 dev_err(host->dev, "Unable to set cfg_div_clk to %lu. ret=%d\n",
382 host->req_rate = rate;
383 mmc->actual_clock = clk_get_rate(host->mmc_clk);
385 /* We should report the real output frequency of the controller */
387 host->req_rate >>= 1;
388 mmc->actual_clock >>= 1;
391 dev_dbg(host->dev, "clk rate: %u Hz\n", mmc->actual_clock);
392 if (rate != mmc->actual_clock)
393 dev_dbg(host->dev, "requested rate was %lu\n", rate);
395 /* (re)start clock */
396 meson_mmc_clk_ungate(host);
402 * The SD/eMMC IP block has an internal mux and divider used for
403 * generating the MMC clock. Use the clock framework to create and
404 * manage these clocks.
406 static int meson_mmc_clk_init(struct meson_host *host)
408 struct clk_init_data init;
410 struct clk_divider *div;
413 const char *mux_parent_names[MUX_CLK_NUM_PARENTS];
414 const char *clk_parent[1];
417 /* init SD_EMMC_CLOCK to sane defaults w/min clock rate */
418 clk_reg = CLK_ALWAYS_ON(host);
419 clk_reg |= CLK_DIV_MASK;
420 clk_reg |= FIELD_PREP(CLK_CORE_PHASE_MASK, CLK_PHASE_180);
421 clk_reg |= FIELD_PREP(CLK_TX_PHASE_MASK, CLK_PHASE_0);
422 clk_reg |= FIELD_PREP(CLK_RX_PHASE_MASK, CLK_PHASE_0);
423 writel(clk_reg, host->regs + SD_EMMC_CLOCK);
425 /* get the mux parents */
426 for (i = 0; i < MUX_CLK_NUM_PARENTS; i++) {
430 snprintf(name, sizeof(name), "clkin%d", i);
431 clk = devm_clk_get(host->dev, name);
433 return dev_err_probe(host->dev, PTR_ERR(clk),
434 "Missing clock %s\n", name);
436 mux_parent_names[i] = __clk_get_name(clk);
440 mux = devm_kzalloc(host->dev, sizeof(*mux), GFP_KERNEL);
444 snprintf(clk_name, sizeof(clk_name), "%s#mux", dev_name(host->dev));
445 init.name = clk_name;
446 init.ops = &clk_mux_ops;
448 init.parent_names = mux_parent_names;
449 init.num_parents = MUX_CLK_NUM_PARENTS;
451 mux->reg = host->regs + SD_EMMC_CLOCK;
452 mux->shift = __ffs(CLK_SRC_MASK);
453 mux->mask = CLK_SRC_MASK >> mux->shift;
454 mux->hw.init = &init;
456 host->mux_clk = devm_clk_register(host->dev, &mux->hw);
457 if (WARN_ON(IS_ERR(host->mux_clk)))
458 return PTR_ERR(host->mux_clk);
460 /* create the divider */
461 div = devm_kzalloc(host->dev, sizeof(*div), GFP_KERNEL);
465 snprintf(clk_name, sizeof(clk_name), "%s#div", dev_name(host->dev));
466 init.name = clk_name;
467 init.ops = &clk_divider_ops;
468 init.flags = CLK_SET_RATE_PARENT;
469 clk_parent[0] = __clk_get_name(host->mux_clk);
470 init.parent_names = clk_parent;
471 init.num_parents = 1;
473 div->reg = host->regs + SD_EMMC_CLOCK;
474 div->shift = __ffs(CLK_DIV_MASK);
475 div->width = __builtin_popcountl(CLK_DIV_MASK);
476 div->hw.init = &init;
477 div->flags = CLK_DIVIDER_ONE_BASED;
479 host->mmc_clk = devm_clk_register(host->dev, &div->hw);
480 if (WARN_ON(IS_ERR(host->mmc_clk)))
481 return PTR_ERR(host->mmc_clk);
483 /* init SD_EMMC_CLOCK to sane defaults w/min clock rate */
484 host->mmc->f_min = clk_round_rate(host->mmc_clk, 400000);
485 ret = clk_set_rate(host->mmc_clk, host->mmc->f_min);
489 return clk_prepare_enable(host->mmc_clk);
492 static void meson_mmc_disable_resampling(struct meson_host *host)
494 unsigned int val = readl(host->regs + host->data->adjust);
496 val &= ~ADJUST_ADJ_EN;
497 writel(val, host->regs + host->data->adjust);
500 static void meson_mmc_reset_resampling(struct meson_host *host)
504 meson_mmc_disable_resampling(host);
506 val = readl(host->regs + host->data->adjust);
507 val &= ~ADJUST_ADJ_DELAY_MASK;
508 writel(val, host->regs + host->data->adjust);
511 static int meson_mmc_resampling_tuning(struct mmc_host *mmc, u32 opcode)
513 struct meson_host *host = mmc_priv(mmc);
514 unsigned int val, dly, max_dly, i;
517 /* Resampling is done using the source clock */
518 max_dly = DIV_ROUND_UP(clk_get_rate(host->mux_clk),
519 clk_get_rate(host->mmc_clk));
521 val = readl(host->regs + host->data->adjust);
522 val |= ADJUST_ADJ_EN;
523 writel(val, host->regs + host->data->adjust);
525 if (mmc_doing_retune(mmc))
526 dly = FIELD_GET(ADJUST_ADJ_DELAY_MASK, val) + 1;
530 for (i = 0; i < max_dly; i++) {
531 val &= ~ADJUST_ADJ_DELAY_MASK;
532 val |= FIELD_PREP(ADJUST_ADJ_DELAY_MASK, (dly + i) % max_dly);
533 writel(val, host->regs + host->data->adjust);
535 ret = mmc_send_tuning(mmc, opcode, NULL);
537 dev_dbg(mmc_dev(mmc), "resampling delay: %u\n",
538 (dly + i) % max_dly);
543 meson_mmc_reset_resampling(host);
547 static int meson_mmc_prepare_ios_clock(struct meson_host *host,
552 switch (ios->timing) {
553 case MMC_TIMING_MMC_DDR52:
554 case MMC_TIMING_UHS_DDR50:
563 return meson_mmc_clk_set(host, ios->clock, ddr);
566 static void meson_mmc_check_resampling(struct meson_host *host,
569 switch (ios->timing) {
570 case MMC_TIMING_LEGACY:
571 case MMC_TIMING_MMC_HS:
572 case MMC_TIMING_SD_HS:
573 case MMC_TIMING_MMC_DDR52:
574 meson_mmc_disable_resampling(host);
579 static void meson_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
581 struct meson_host *host = mmc_priv(mmc);
586 * GPIO regulator, only controls switching between 1v8 and
587 * 3v3, doesn't support MMC_POWER_OFF, MMC_POWER_ON.
589 switch (ios->power_mode) {
591 if (!IS_ERR(mmc->supply.vmmc))
592 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, 0);
594 if (!IS_ERR(mmc->supply.vqmmc) && host->vqmmc_enabled) {
595 regulator_disable(mmc->supply.vqmmc);
596 host->vqmmc_enabled = false;
602 if (!IS_ERR(mmc->supply.vmmc))
603 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, ios->vdd);
608 if (!IS_ERR(mmc->supply.vqmmc) && !host->vqmmc_enabled) {
609 int ret = regulator_enable(mmc->supply.vqmmc);
613 "failed to enable vqmmc regulator\n");
615 host->vqmmc_enabled = true;
622 switch (ios->bus_width) {
623 case MMC_BUS_WIDTH_1:
624 bus_width = CFG_BUS_WIDTH_1;
626 case MMC_BUS_WIDTH_4:
627 bus_width = CFG_BUS_WIDTH_4;
629 case MMC_BUS_WIDTH_8:
630 bus_width = CFG_BUS_WIDTH_8;
633 dev_err(host->dev, "Invalid ios->bus_width: %u. Setting to 4.\n",
635 bus_width = CFG_BUS_WIDTH_4;
638 val = readl(host->regs + SD_EMMC_CFG);
639 val &= ~CFG_BUS_WIDTH_MASK;
640 val |= FIELD_PREP(CFG_BUS_WIDTH_MASK, bus_width);
641 writel(val, host->regs + SD_EMMC_CFG);
643 meson_mmc_check_resampling(host, ios);
644 err = meson_mmc_prepare_ios_clock(host, ios);
646 dev_err(host->dev, "Failed to set clock: %d\n,", err);
648 dev_dbg(host->dev, "SD_EMMC_CFG: 0x%08x\n", val);
651 static void meson_mmc_request_done(struct mmc_host *mmc,
652 struct mmc_request *mrq)
654 struct meson_host *host = mmc_priv(mmc);
657 if (host->needs_pre_post_req)
658 meson_mmc_post_req(mmc, mrq, 0);
659 mmc_request_done(host->mmc, mrq);
662 static void meson_mmc_set_blksz(struct mmc_host *mmc, unsigned int blksz)
664 struct meson_host *host = mmc_priv(mmc);
667 cfg = readl(host->regs + SD_EMMC_CFG);
668 blksz_old = FIELD_GET(CFG_BLK_LEN_MASK, cfg);
670 if (!is_power_of_2(blksz))
671 dev_err(host->dev, "blksz %u is not a power of 2\n", blksz);
673 blksz = ilog2(blksz);
675 /* check if block-size matches, if not update */
676 if (blksz == blksz_old)
679 dev_dbg(host->dev, "%s: update blk_len %d -> %d\n", __func__,
682 cfg &= ~CFG_BLK_LEN_MASK;
683 cfg |= FIELD_PREP(CFG_BLK_LEN_MASK, blksz);
684 writel(cfg, host->regs + SD_EMMC_CFG);
687 static void meson_mmc_set_response_bits(struct mmc_command *cmd, u32 *cmd_cfg)
689 if (cmd->flags & MMC_RSP_PRESENT) {
690 if (cmd->flags & MMC_RSP_136)
691 *cmd_cfg |= CMD_CFG_RESP_128;
692 *cmd_cfg |= CMD_CFG_RESP_NUM;
694 if (!(cmd->flags & MMC_RSP_CRC))
695 *cmd_cfg |= CMD_CFG_RESP_NOCRC;
697 if (cmd->flags & MMC_RSP_BUSY)
698 *cmd_cfg |= CMD_CFG_R1B;
700 *cmd_cfg |= CMD_CFG_NO_RESP;
704 static void meson_mmc_desc_chain_transfer(struct mmc_host *mmc, u32 cmd_cfg)
706 struct meson_host *host = mmc_priv(mmc);
707 struct sd_emmc_desc *desc = host->descs;
708 struct mmc_data *data = host->cmd->data;
709 struct scatterlist *sg;
713 if (data->flags & MMC_DATA_WRITE)
714 cmd_cfg |= CMD_CFG_DATA_WR;
716 if (data->blocks > 1) {
717 cmd_cfg |= CMD_CFG_BLOCK_MODE;
718 meson_mmc_set_blksz(mmc, data->blksz);
721 for_each_sg(data->sg, sg, data->sg_count, i) {
722 unsigned int len = sg_dma_len(sg);
724 if (data->blocks > 1)
727 desc[i].cmd_cfg = cmd_cfg;
728 desc[i].cmd_cfg |= FIELD_PREP(CMD_CFG_LENGTH_MASK, len);
730 desc[i].cmd_cfg |= CMD_CFG_NO_CMD;
731 desc[i].cmd_arg = host->cmd->arg;
732 desc[i].cmd_resp = 0;
733 desc[i].cmd_data = sg_dma_address(sg);
735 desc[data->sg_count - 1].cmd_cfg |= CMD_CFG_END_OF_CHAIN;
737 dma_wmb(); /* ensure descriptor is written before kicked */
738 start = host->descs_dma_addr | START_DESC_BUSY;
739 writel(start, host->regs + SD_EMMC_START);
742 /* local sg copy for dram_access_quirk */
743 static void meson_mmc_copy_buffer(struct meson_host *host, struct mmc_data *data,
744 size_t buflen, bool to_buffer)
746 unsigned int sg_flags = SG_MITER_ATOMIC;
747 struct scatterlist *sgl = data->sg;
748 unsigned int nents = data->sg_len;
749 struct sg_mapping_iter miter;
750 unsigned int offset = 0;
753 sg_flags |= SG_MITER_FROM_SG;
755 sg_flags |= SG_MITER_TO_SG;
757 sg_miter_start(&miter, sgl, nents, sg_flags);
759 while ((offset < buflen) && sg_miter_next(&miter)) {
760 unsigned int buf_offset = 0;
761 unsigned int len, left;
762 u32 *buf = miter.addr;
764 len = min(miter.length, buflen - offset);
769 writel(*buf++, host->bounce_iomem_buf + offset + buf_offset);
776 *buf++ = readl(host->bounce_iomem_buf + offset + buf_offset);
786 sg_miter_stop(&miter);
789 static void meson_mmc_start_cmd(struct mmc_host *mmc, struct mmc_command *cmd)
791 struct meson_host *host = mmc_priv(mmc);
792 struct mmc_data *data = cmd->data;
793 u32 cmd_cfg = 0, cmd_data = 0;
794 unsigned int xfer_bytes = 0;
796 /* Setup descriptors */
801 cmd_cfg |= FIELD_PREP(CMD_CFG_CMD_INDEX_MASK, cmd->opcode);
802 cmd_cfg |= CMD_CFG_OWNER; /* owned by CPU */
803 cmd_cfg |= CMD_CFG_ERROR; /* stop in case of error */
805 meson_mmc_set_response_bits(cmd, &cmd_cfg);
809 data->bytes_xfered = 0;
810 cmd_cfg |= CMD_CFG_DATA_IO;
811 cmd_cfg |= FIELD_PREP(CMD_CFG_TIMEOUT_MASK,
812 ilog2(meson_mmc_get_timeout_msecs(data)));
814 if (meson_mmc_desc_chain_mode(data)) {
815 meson_mmc_desc_chain_transfer(mmc, cmd_cfg);
819 if (data->blocks > 1) {
820 cmd_cfg |= CMD_CFG_BLOCK_MODE;
821 cmd_cfg |= FIELD_PREP(CMD_CFG_LENGTH_MASK,
823 meson_mmc_set_blksz(mmc, data->blksz);
825 cmd_cfg |= FIELD_PREP(CMD_CFG_LENGTH_MASK, data->blksz);
828 xfer_bytes = data->blksz * data->blocks;
829 if (data->flags & MMC_DATA_WRITE) {
830 cmd_cfg |= CMD_CFG_DATA_WR;
831 WARN_ON(xfer_bytes > host->bounce_buf_size);
832 if (host->dram_access_quirk)
833 meson_mmc_copy_buffer(host, data, xfer_bytes, true);
835 sg_copy_to_buffer(data->sg, data->sg_len,
836 host->bounce_buf, xfer_bytes);
840 cmd_data = host->bounce_dma_addr & CMD_DATA_MASK;
842 cmd_cfg |= FIELD_PREP(CMD_CFG_TIMEOUT_MASK,
843 ilog2(SD_EMMC_CMD_TIMEOUT));
846 /* Last descriptor */
847 cmd_cfg |= CMD_CFG_END_OF_CHAIN;
848 writel(cmd_cfg, host->regs + SD_EMMC_CMD_CFG);
849 writel(cmd_data, host->regs + SD_EMMC_CMD_DAT);
850 writel(0, host->regs + SD_EMMC_CMD_RSP);
851 wmb(); /* ensure descriptor is written before kicked */
852 writel(cmd->arg, host->regs + SD_EMMC_CMD_ARG);
855 static int meson_mmc_validate_dram_access(struct mmc_host *mmc, struct mmc_data *data)
857 struct scatterlist *sg;
860 /* Reject request if any element offset or size is not 32bit aligned */
861 for_each_sg(data->sg, sg, data->sg_len, i) {
862 if (!IS_ALIGNED(sg->offset, sizeof(u32)) ||
863 !IS_ALIGNED(sg->length, sizeof(u32))) {
864 dev_err(mmc_dev(mmc), "unaligned sg offset %u len %u\n",
865 data->sg->offset, data->sg->length);
873 static void meson_mmc_request(struct mmc_host *mmc, struct mmc_request *mrq)
875 struct meson_host *host = mmc_priv(mmc);
876 host->needs_pre_post_req = mrq->data &&
877 !(mrq->data->host_cookie & SD_EMMC_PRE_REQ_DONE);
880 * The memory at the end of the controller used as bounce buffer for
881 * the dram_access_quirk only accepts 32bit read/write access,
882 * check the aligment and length of the data before starting the request.
884 if (host->dram_access_quirk && mrq->data) {
885 mrq->cmd->error = meson_mmc_validate_dram_access(mmc, mrq->data);
886 if (mrq->cmd->error) {
887 mmc_request_done(mmc, mrq);
892 if (host->needs_pre_post_req) {
893 meson_mmc_get_transfer_mode(mmc, mrq);
894 if (!meson_mmc_desc_chain_mode(mrq->data))
895 host->needs_pre_post_req = false;
898 if (host->needs_pre_post_req)
899 meson_mmc_pre_req(mmc, mrq);
902 writel(0, host->regs + SD_EMMC_START);
904 meson_mmc_start_cmd(mmc, mrq->sbc ?: mrq->cmd);
907 static void meson_mmc_read_resp(struct mmc_host *mmc, struct mmc_command *cmd)
909 struct meson_host *host = mmc_priv(mmc);
911 if (cmd->flags & MMC_RSP_136) {
912 cmd->resp[0] = readl(host->regs + SD_EMMC_CMD_RSP3);
913 cmd->resp[1] = readl(host->regs + SD_EMMC_CMD_RSP2);
914 cmd->resp[2] = readl(host->regs + SD_EMMC_CMD_RSP1);
915 cmd->resp[3] = readl(host->regs + SD_EMMC_CMD_RSP);
916 } else if (cmd->flags & MMC_RSP_PRESENT) {
917 cmd->resp[0] = readl(host->regs + SD_EMMC_CMD_RSP);
921 static irqreturn_t meson_mmc_irq(int irq, void *dev_id)
923 struct meson_host *host = dev_id;
924 struct mmc_command *cmd;
925 struct mmc_data *data;
926 u32 irq_en, status, raw_status;
927 irqreturn_t ret = IRQ_NONE;
929 irq_en = readl(host->regs + SD_EMMC_IRQ_EN);
930 raw_status = readl(host->regs + SD_EMMC_STATUS);
931 status = raw_status & irq_en;
935 "Unexpected IRQ! irq_en 0x%08x - status 0x%08x\n",
940 if (WARN_ON(!host) || WARN_ON(!host->cmd))
943 /* ack all raised interrupts */
944 writel(status, host->regs + SD_EMMC_STATUS);
949 if (status & IRQ_CRC_ERR) {
950 dev_dbg(host->dev, "CRC Error - status 0x%08x\n", status);
951 cmd->error = -EILSEQ;
952 ret = IRQ_WAKE_THREAD;
956 if (status & IRQ_TIMEOUTS) {
957 dev_dbg(host->dev, "Timeout - status 0x%08x\n", status);
958 cmd->error = -ETIMEDOUT;
959 ret = IRQ_WAKE_THREAD;
963 meson_mmc_read_resp(host->mmc, cmd);
965 if (status & IRQ_SDIO) {
966 dev_dbg(host->dev, "IRQ: SDIO TODO.\n");
970 if (status & (IRQ_END_OF_CHAIN | IRQ_RESP_STATUS)) {
971 if (data && !cmd->error)
972 data->bytes_xfered = data->blksz * data->blocks;
973 if (meson_mmc_bounce_buf_read(data) ||
974 meson_mmc_get_next_command(cmd))
975 ret = IRQ_WAKE_THREAD;
982 /* Stop desc in case of errors */
983 u32 start = readl(host->regs + SD_EMMC_START);
985 start &= ~START_DESC_BUSY;
986 writel(start, host->regs + SD_EMMC_START);
989 if (ret == IRQ_HANDLED)
990 meson_mmc_request_done(host->mmc, cmd->mrq);
995 static int meson_mmc_wait_desc_stop(struct meson_host *host)
1000 * It may sometimes take a while for it to actually halt. Here, we
1001 * are giving it 5ms to comply
1003 * If we don't confirm the descriptor is stopped, it might raise new
1004 * IRQs after we have called mmc_request_done() which is bad.
1007 return readl_poll_timeout(host->regs + SD_EMMC_STATUS, status,
1008 !(status & (STATUS_BUSY | STATUS_DESC_BUSY)),
1012 static irqreturn_t meson_mmc_irq_thread(int irq, void *dev_id)
1014 struct meson_host *host = dev_id;
1015 struct mmc_command *next_cmd, *cmd = host->cmd;
1016 struct mmc_data *data;
1017 unsigned int xfer_bytes;
1023 meson_mmc_wait_desc_stop(host);
1024 meson_mmc_request_done(host->mmc, cmd->mrq);
1030 if (meson_mmc_bounce_buf_read(data)) {
1031 xfer_bytes = data->blksz * data->blocks;
1032 WARN_ON(xfer_bytes > host->bounce_buf_size);
1033 if (host->dram_access_quirk)
1034 meson_mmc_copy_buffer(host, data, xfer_bytes, false);
1036 sg_copy_from_buffer(data->sg, data->sg_len,
1037 host->bounce_buf, xfer_bytes);
1040 next_cmd = meson_mmc_get_next_command(cmd);
1042 meson_mmc_start_cmd(host->mmc, next_cmd);
1044 meson_mmc_request_done(host->mmc, cmd->mrq);
1050 * NOTE: we only need this until the GPIO/pinctrl driver can handle
1051 * interrupts. For now, the MMC core will use this for polling.
1053 static int meson_mmc_get_cd(struct mmc_host *mmc)
1055 int status = mmc_gpio_get_cd(mmc);
1057 if (status == -ENOSYS)
1058 return 1; /* assume present */
1063 static void meson_mmc_cfg_init(struct meson_host *host)
1067 cfg |= FIELD_PREP(CFG_RESP_TIMEOUT_MASK,
1068 ilog2(SD_EMMC_CFG_RESP_TIMEOUT));
1069 cfg |= FIELD_PREP(CFG_RC_CC_MASK, ilog2(SD_EMMC_CFG_CMD_GAP));
1070 cfg |= FIELD_PREP(CFG_BLK_LEN_MASK, ilog2(SD_EMMC_CFG_BLK_SIZE));
1072 /* abort chain on R/W errors */
1073 cfg |= CFG_ERR_ABORT;
1075 writel(cfg, host->regs + SD_EMMC_CFG);
1078 static int meson_mmc_card_busy(struct mmc_host *mmc)
1080 struct meson_host *host = mmc_priv(mmc);
1083 regval = readl(host->regs + SD_EMMC_STATUS);
1085 /* We are only interrested in lines 0 to 3, so mask the other ones */
1086 return !(FIELD_GET(STATUS_DATI, regval) & 0xf);
1089 static int meson_mmc_voltage_switch(struct mmc_host *mmc, struct mmc_ios *ios)
1093 /* vqmmc regulator is available */
1094 if (!IS_ERR(mmc->supply.vqmmc)) {
1096 * The usual amlogic setup uses a GPIO to switch from one
1097 * regulator to the other. While the voltage ramp up is
1098 * pretty fast, care must be taken when switching from 3.3v
1099 * to 1.8v. Please make sure the regulator framework is aware
1100 * of your own regulator constraints
1102 ret = mmc_regulator_set_vqmmc(mmc, ios);
1103 return ret < 0 ? ret : 0;
1106 /* no vqmmc regulator, assume fixed regulator at 3/3.3V */
1107 if (ios->signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1113 static const struct mmc_host_ops meson_mmc_ops = {
1114 .request = meson_mmc_request,
1115 .set_ios = meson_mmc_set_ios,
1116 .get_cd = meson_mmc_get_cd,
1117 .pre_req = meson_mmc_pre_req,
1118 .post_req = meson_mmc_post_req,
1119 .execute_tuning = meson_mmc_resampling_tuning,
1120 .card_busy = meson_mmc_card_busy,
1121 .start_signal_voltage_switch = meson_mmc_voltage_switch,
1124 static int meson_mmc_probe(struct platform_device *pdev)
1126 struct resource *res;
1127 struct meson_host *host;
1128 struct mmc_host *mmc;
1131 mmc = mmc_alloc_host(sizeof(struct meson_host), &pdev->dev);
1134 host = mmc_priv(mmc);
1136 host->dev = &pdev->dev;
1137 dev_set_drvdata(&pdev->dev, host);
1139 /* The G12A SDIO Controller needs an SRAM bounce buffer */
1140 host->dram_access_quirk = device_property_read_bool(&pdev->dev,
1141 "amlogic,dram-access-quirk");
1143 /* Get regulators and the supported OCR mask */
1144 host->vqmmc_enabled = false;
1145 ret = mmc_regulator_get_supply(mmc);
1149 ret = mmc_of_parse(mmc);
1151 if (ret != -EPROBE_DEFER)
1152 dev_warn(&pdev->dev, "error parsing DT: %d\n", ret);
1156 host->data = (struct meson_mmc_data *)
1157 of_device_get_match_data(&pdev->dev);
1163 ret = device_reset_optional(&pdev->dev);
1165 dev_err_probe(&pdev->dev, ret, "device reset failed\n");
1169 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1170 host->regs = devm_ioremap_resource(&pdev->dev, res);
1171 if (IS_ERR(host->regs)) {
1172 ret = PTR_ERR(host->regs);
1176 host->irq = platform_get_irq(pdev, 0);
1177 if (host->irq <= 0) {
1182 host->pinctrl = devm_pinctrl_get(&pdev->dev);
1183 if (IS_ERR(host->pinctrl)) {
1184 ret = PTR_ERR(host->pinctrl);
1188 host->pins_clk_gate = pinctrl_lookup_state(host->pinctrl,
1190 if (IS_ERR(host->pins_clk_gate)) {
1191 dev_warn(&pdev->dev,
1192 "can't get clk-gate pinctrl, using clk_stop bit\n");
1193 host->pins_clk_gate = NULL;
1196 host->core_clk = devm_clk_get(&pdev->dev, "core");
1197 if (IS_ERR(host->core_clk)) {
1198 ret = PTR_ERR(host->core_clk);
1202 ret = clk_prepare_enable(host->core_clk);
1206 ret = meson_mmc_clk_init(host);
1210 /* set config to sane default */
1211 meson_mmc_cfg_init(host);
1213 /* Stop execution */
1214 writel(0, host->regs + SD_EMMC_START);
1216 /* clear, ack and enable interrupts */
1217 writel(0, host->regs + SD_EMMC_IRQ_EN);
1218 writel(IRQ_CRC_ERR | IRQ_TIMEOUTS | IRQ_END_OF_CHAIN,
1219 host->regs + SD_EMMC_STATUS);
1220 writel(IRQ_CRC_ERR | IRQ_TIMEOUTS | IRQ_END_OF_CHAIN,
1221 host->regs + SD_EMMC_IRQ_EN);
1223 ret = request_threaded_irq(host->irq, meson_mmc_irq,
1224 meson_mmc_irq_thread, IRQF_ONESHOT,
1225 dev_name(&pdev->dev), host);
1229 mmc->caps |= MMC_CAP_CMD23;
1230 if (host->dram_access_quirk) {
1231 /* Limit segments to 1 due to low available sram memory */
1233 /* Limit to the available sram memory */
1234 mmc->max_blk_count = SD_EMMC_SRAM_DATA_BUF_LEN /
1237 mmc->max_blk_count = CMD_CFG_LENGTH_MASK;
1238 mmc->max_segs = SD_EMMC_DESC_BUF_LEN /
1239 sizeof(struct sd_emmc_desc);
1241 mmc->max_req_size = mmc->max_blk_count * mmc->max_blk_size;
1242 mmc->max_seg_size = mmc->max_req_size;
1245 * At the moment, we don't know how to reliably enable HS400.
1246 * From the different datasheets, it is not even clear if this mode
1247 * is officially supported by any of the SoCs
1249 mmc->caps2 &= ~MMC_CAP2_HS400;
1251 if (host->dram_access_quirk) {
1253 * The MMC Controller embeds 1,5KiB of internal SRAM
1254 * that can be used to be used as bounce buffer.
1255 * In the case of the G12A SDIO controller, use these
1256 * instead of the DDR memory
1258 host->bounce_buf_size = SD_EMMC_SRAM_DATA_BUF_LEN;
1259 host->bounce_iomem_buf = host->regs + SD_EMMC_SRAM_DATA_BUF_OFF;
1260 host->bounce_dma_addr = res->start + SD_EMMC_SRAM_DATA_BUF_OFF;
1262 /* data bounce buffer */
1263 host->bounce_buf_size = mmc->max_req_size;
1265 dma_alloc_coherent(host->dev, host->bounce_buf_size,
1266 &host->bounce_dma_addr, GFP_KERNEL);
1267 if (host->bounce_buf == NULL) {
1268 dev_err(host->dev, "Unable to map allocate DMA bounce buffer.\n");
1274 host->descs = dma_alloc_coherent(host->dev, SD_EMMC_DESC_BUF_LEN,
1275 &host->descs_dma_addr, GFP_KERNEL);
1277 dev_err(host->dev, "Allocating descriptor DMA buffer failed\n");
1279 goto err_bounce_buf;
1282 mmc->ops = &meson_mmc_ops;
1288 if (!host->dram_access_quirk)
1289 dma_free_coherent(host->dev, host->bounce_buf_size,
1290 host->bounce_buf, host->bounce_dma_addr);
1292 free_irq(host->irq, host);
1294 clk_disable_unprepare(host->mmc_clk);
1296 clk_disable_unprepare(host->core_clk);
1302 static int meson_mmc_remove(struct platform_device *pdev)
1304 struct meson_host *host = dev_get_drvdata(&pdev->dev);
1306 mmc_remove_host(host->mmc);
1308 /* disable interrupts */
1309 writel(0, host->regs + SD_EMMC_IRQ_EN);
1310 free_irq(host->irq, host);
1312 dma_free_coherent(host->dev, SD_EMMC_DESC_BUF_LEN,
1313 host->descs, host->descs_dma_addr);
1315 if (!host->dram_access_quirk)
1316 dma_free_coherent(host->dev, host->bounce_buf_size,
1317 host->bounce_buf, host->bounce_dma_addr);
1319 clk_disable_unprepare(host->mmc_clk);
1320 clk_disable_unprepare(host->core_clk);
1322 mmc_free_host(host->mmc);
1326 static const struct meson_mmc_data meson_gx_data = {
1327 .tx_delay_mask = CLK_V2_TX_DELAY_MASK,
1328 .rx_delay_mask = CLK_V2_RX_DELAY_MASK,
1329 .always_on = CLK_V2_ALWAYS_ON,
1330 .adjust = SD_EMMC_ADJUST,
1333 static const struct meson_mmc_data meson_axg_data = {
1334 .tx_delay_mask = CLK_V3_TX_DELAY_MASK,
1335 .rx_delay_mask = CLK_V3_RX_DELAY_MASK,
1336 .always_on = CLK_V3_ALWAYS_ON,
1337 .adjust = SD_EMMC_V3_ADJUST,
1340 static const struct of_device_id meson_mmc_of_match[] = {
1341 { .compatible = "amlogic,meson-gx-mmc", .data = &meson_gx_data },
1342 { .compatible = "amlogic,meson-gxbb-mmc", .data = &meson_gx_data },
1343 { .compatible = "amlogic,meson-gxl-mmc", .data = &meson_gx_data },
1344 { .compatible = "amlogic,meson-gxm-mmc", .data = &meson_gx_data },
1345 { .compatible = "amlogic,meson-axg-mmc", .data = &meson_axg_data },
1348 MODULE_DEVICE_TABLE(of, meson_mmc_of_match);
1350 static struct platform_driver meson_mmc_driver = {
1351 .probe = meson_mmc_probe,
1352 .remove = meson_mmc_remove,
1354 .name = DRIVER_NAME,
1355 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1356 .of_match_table = of_match_ptr(meson_mmc_of_match),
1360 module_platform_driver(meson_mmc_driver);
1362 MODULE_DESCRIPTION("Amlogic S905*/GX*/AXG SD/eMMC driver");
1363 MODULE_AUTHOR("Kevin Hilman <khilman@baylibre.com>");
1364 MODULE_LICENSE("GPL v2");