treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / drivers / mmc / host / meson-gx-mmc.c
blob35400cf2a2e4a59733a6fc0a630d0e69748866d9
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Amlogic SD/eMMC driver for the GX/S905 family SoCs
5 * Copyright (c) 2016 BayLibre, SAS.
6 * Author: Kevin Hilman <khilman@baylibre.com>
7 */
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>
22 #include <linux/io.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)
39 #define CLK_PHASE_0 0
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)
94 #define IRQ_CRC_ERR \
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 |\
105 IRQ_SDIO)
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;
138 unsigned int adjust;
141 struct sd_emmc_desc {
142 u32 cmd_cfg;
143 u32 cmd_arg;
144 u32 cmd_data;
145 u32 cmd_resp;
148 struct meson_host {
149 struct device *dev;
150 struct meson_mmc_data *data;
151 struct mmc_host *mmc;
152 struct mmc_command *cmd;
154 void __iomem *regs;
155 struct clk *core_clk;
156 struct clk *mux_clk;
157 struct clk *mmc_clk;
158 unsigned long req_rate;
159 bool ddr;
161 bool dram_access_quirk;
163 struct pinctrl *pinctrl;
164 struct pinctrl_state *pins_clk_gate;
166 unsigned int bounce_buf_size;
167 void *bounce_buf;
168 dma_addr_t bounce_dma_addr;
169 struct sd_emmc_desc *descs;
170 dma_addr_t descs_dma_addr;
172 int irq;
174 bool vqmmc_enabled;
177 #define CMD_CFG_LENGTH_MASK GENMASK(8, 0)
178 #define CMD_CFG_BLOCK_MODE BIT(9)
179 #define CMD_CFG_R1B BIT(10)
180 #define CMD_CFG_END_OF_CHAIN BIT(11)
181 #define CMD_CFG_TIMEOUT_MASK GENMASK(15, 12)
182 #define CMD_CFG_NO_RESP BIT(16)
183 #define CMD_CFG_NO_CMD BIT(17)
184 #define CMD_CFG_DATA_IO BIT(18)
185 #define CMD_CFG_DATA_WR BIT(19)
186 #define CMD_CFG_RESP_NOCRC BIT(20)
187 #define CMD_CFG_RESP_128 BIT(21)
188 #define CMD_CFG_RESP_NUM BIT(22)
189 #define CMD_CFG_DATA_NUM BIT(23)
190 #define CMD_CFG_CMD_INDEX_MASK GENMASK(29, 24)
191 #define CMD_CFG_ERROR BIT(30)
192 #define CMD_CFG_OWNER BIT(31)
194 #define CMD_DATA_MASK GENMASK(31, 2)
195 #define CMD_DATA_BIG_ENDIAN BIT(1)
196 #define CMD_DATA_SRAM BIT(0)
197 #define CMD_RESP_MASK GENMASK(31, 1)
198 #define CMD_RESP_SRAM BIT(0)
200 static unsigned int meson_mmc_get_timeout_msecs(struct mmc_data *data)
202 unsigned int timeout = data->timeout_ns / NSEC_PER_MSEC;
204 if (!timeout)
205 return SD_EMMC_CMD_TIMEOUT_DATA;
207 timeout = roundup_pow_of_two(timeout);
209 return min(timeout, 32768U); /* max. 2^15 ms */
212 static struct mmc_command *meson_mmc_get_next_command(struct mmc_command *cmd)
214 if (cmd->opcode == MMC_SET_BLOCK_COUNT && !cmd->error)
215 return cmd->mrq->cmd;
216 else if (mmc_op_multi(cmd->opcode) &&
217 (!cmd->mrq->sbc || cmd->error || cmd->data->error))
218 return cmd->mrq->stop;
219 else
220 return NULL;
223 static void meson_mmc_get_transfer_mode(struct mmc_host *mmc,
224 struct mmc_request *mrq)
226 struct meson_host *host = mmc_priv(mmc);
227 struct mmc_data *data = mrq->data;
228 struct scatterlist *sg;
229 int i;
230 bool use_desc_chain_mode = true;
233 * When Controller DMA cannot directly access DDR memory, disable
234 * support for Chain Mode to directly use the internal SRAM using
235 * the bounce buffer mode.
237 if (host->dram_access_quirk)
238 return;
241 * Broken SDIO with AP6255-based WiFi on Khadas VIM Pro has been
242 * reported. For some strange reason this occurs in descriptor
243 * chain mode only. So let's fall back to bounce buffer mode
244 * for command SD_IO_RW_EXTENDED.
246 if (mrq->cmd->opcode == SD_IO_RW_EXTENDED)
247 return;
249 for_each_sg(data->sg, sg, data->sg_len, i)
250 /* check for 8 byte alignment */
251 if (sg->offset & 7) {
252 WARN_ONCE(1, "unaligned scatterlist buffer\n");
253 use_desc_chain_mode = false;
254 break;
257 if (use_desc_chain_mode)
258 data->host_cookie |= SD_EMMC_DESC_CHAIN_MODE;
261 static inline bool meson_mmc_desc_chain_mode(const struct mmc_data *data)
263 return data->host_cookie & SD_EMMC_DESC_CHAIN_MODE;
266 static inline bool meson_mmc_bounce_buf_read(const struct mmc_data *data)
268 return data && data->flags & MMC_DATA_READ &&
269 !meson_mmc_desc_chain_mode(data);
272 static void meson_mmc_pre_req(struct mmc_host *mmc, struct mmc_request *mrq)
274 struct mmc_data *data = mrq->data;
276 if (!data)
277 return;
279 meson_mmc_get_transfer_mode(mmc, mrq);
280 data->host_cookie |= SD_EMMC_PRE_REQ_DONE;
282 if (!meson_mmc_desc_chain_mode(data))
283 return;
285 data->sg_count = dma_map_sg(mmc_dev(mmc), data->sg, data->sg_len,
286 mmc_get_dma_dir(data));
287 if (!data->sg_count)
288 dev_err(mmc_dev(mmc), "dma_map_sg failed");
291 static void meson_mmc_post_req(struct mmc_host *mmc, struct mmc_request *mrq,
292 int err)
294 struct mmc_data *data = mrq->data;
296 if (data && meson_mmc_desc_chain_mode(data) && data->sg_count)
297 dma_unmap_sg(mmc_dev(mmc), data->sg, data->sg_len,
298 mmc_get_dma_dir(data));
302 * Gating the clock on this controller is tricky. It seems the mmc clock
303 * is also used by the controller. It may crash during some operation if the
304 * clock is stopped. The safest thing to do, whenever possible, is to keep
305 * clock running at stop it at the pad using the pinmux.
307 static void meson_mmc_clk_gate(struct meson_host *host)
309 u32 cfg;
311 if (host->pins_clk_gate) {
312 pinctrl_select_state(host->pinctrl, host->pins_clk_gate);
313 } else {
315 * If the pinmux is not provided - default to the classic and
316 * unsafe method
318 cfg = readl(host->regs + SD_EMMC_CFG);
319 cfg |= CFG_STOP_CLOCK;
320 writel(cfg, host->regs + SD_EMMC_CFG);
324 static void meson_mmc_clk_ungate(struct meson_host *host)
326 u32 cfg;
328 if (host->pins_clk_gate)
329 pinctrl_select_default_state(host->dev);
331 /* Make sure the clock is not stopped in the controller */
332 cfg = readl(host->regs + SD_EMMC_CFG);
333 cfg &= ~CFG_STOP_CLOCK;
334 writel(cfg, host->regs + SD_EMMC_CFG);
337 static int meson_mmc_clk_set(struct meson_host *host, unsigned long rate,
338 bool ddr)
340 struct mmc_host *mmc = host->mmc;
341 int ret;
342 u32 cfg;
344 /* Same request - bail-out */
345 if (host->ddr == ddr && host->req_rate == rate)
346 return 0;
348 /* stop clock */
349 meson_mmc_clk_gate(host);
350 host->req_rate = 0;
351 mmc->actual_clock = 0;
353 /* return with clock being stopped */
354 if (!rate)
355 return 0;
357 /* Stop the clock during rate change to avoid glitches */
358 cfg = readl(host->regs + SD_EMMC_CFG);
359 cfg |= CFG_STOP_CLOCK;
360 writel(cfg, host->regs + SD_EMMC_CFG);
362 if (ddr) {
363 /* DDR modes require higher module clock */
364 rate <<= 1;
365 cfg |= CFG_DDR;
366 } else {
367 cfg &= ~CFG_DDR;
369 writel(cfg, host->regs + SD_EMMC_CFG);
370 host->ddr = ddr;
372 ret = clk_set_rate(host->mmc_clk, rate);
373 if (ret) {
374 dev_err(host->dev, "Unable to set cfg_div_clk to %lu. ret=%d\n",
375 rate, ret);
376 return ret;
379 host->req_rate = rate;
380 mmc->actual_clock = clk_get_rate(host->mmc_clk);
382 /* We should report the real output frequency of the controller */
383 if (ddr) {
384 host->req_rate >>= 1;
385 mmc->actual_clock >>= 1;
388 dev_dbg(host->dev, "clk rate: %u Hz\n", mmc->actual_clock);
389 if (rate != mmc->actual_clock)
390 dev_dbg(host->dev, "requested rate was %lu\n", rate);
392 /* (re)start clock */
393 meson_mmc_clk_ungate(host);
395 return 0;
399 * The SD/eMMC IP block has an internal mux and divider used for
400 * generating the MMC clock. Use the clock framework to create and
401 * manage these clocks.
403 static int meson_mmc_clk_init(struct meson_host *host)
405 struct clk_init_data init;
406 struct clk_mux *mux;
407 struct clk_divider *div;
408 char clk_name[32];
409 int i, ret = 0;
410 const char *mux_parent_names[MUX_CLK_NUM_PARENTS];
411 const char *clk_parent[1];
412 u32 clk_reg;
414 /* init SD_EMMC_CLOCK to sane defaults w/min clock rate */
415 clk_reg = CLK_ALWAYS_ON(host);
416 clk_reg |= CLK_DIV_MASK;
417 clk_reg |= FIELD_PREP(CLK_CORE_PHASE_MASK, CLK_PHASE_180);
418 clk_reg |= FIELD_PREP(CLK_TX_PHASE_MASK, CLK_PHASE_0);
419 clk_reg |= FIELD_PREP(CLK_RX_PHASE_MASK, CLK_PHASE_0);
420 writel(clk_reg, host->regs + SD_EMMC_CLOCK);
422 /* get the mux parents */
423 for (i = 0; i < MUX_CLK_NUM_PARENTS; i++) {
424 struct clk *clk;
425 char name[16];
427 snprintf(name, sizeof(name), "clkin%d", i);
428 clk = devm_clk_get(host->dev, name);
429 if (IS_ERR(clk)) {
430 if (clk != ERR_PTR(-EPROBE_DEFER))
431 dev_err(host->dev, "Missing clock %s\n", name);
432 return PTR_ERR(clk);
435 mux_parent_names[i] = __clk_get_name(clk);
438 /* create the mux */
439 mux = devm_kzalloc(host->dev, sizeof(*mux), GFP_KERNEL);
440 if (!mux)
441 return -ENOMEM;
443 snprintf(clk_name, sizeof(clk_name), "%s#mux", dev_name(host->dev));
444 init.name = clk_name;
445 init.ops = &clk_mux_ops;
446 init.flags = 0;
447 init.parent_names = mux_parent_names;
448 init.num_parents = MUX_CLK_NUM_PARENTS;
450 mux->reg = host->regs + SD_EMMC_CLOCK;
451 mux->shift = __ffs(CLK_SRC_MASK);
452 mux->mask = CLK_SRC_MASK >> mux->shift;
453 mux->hw.init = &init;
455 host->mux_clk = devm_clk_register(host->dev, &mux->hw);
456 if (WARN_ON(IS_ERR(host->mux_clk)))
457 return PTR_ERR(host->mux_clk);
459 /* create the divider */
460 div = devm_kzalloc(host->dev, sizeof(*div), GFP_KERNEL);
461 if (!div)
462 return -ENOMEM;
464 snprintf(clk_name, sizeof(clk_name), "%s#div", dev_name(host->dev));
465 init.name = clk_name;
466 init.ops = &clk_divider_ops;
467 init.flags = CLK_SET_RATE_PARENT;
468 clk_parent[0] = __clk_get_name(host->mux_clk);
469 init.parent_names = clk_parent;
470 init.num_parents = 1;
472 div->reg = host->regs + SD_EMMC_CLOCK;
473 div->shift = __ffs(CLK_DIV_MASK);
474 div->width = __builtin_popcountl(CLK_DIV_MASK);
475 div->hw.init = &init;
476 div->flags = CLK_DIVIDER_ONE_BASED;
478 host->mmc_clk = devm_clk_register(host->dev, &div->hw);
479 if (WARN_ON(IS_ERR(host->mmc_clk)))
480 return PTR_ERR(host->mmc_clk);
482 /* init SD_EMMC_CLOCK to sane defaults w/min clock rate */
483 host->mmc->f_min = clk_round_rate(host->mmc_clk, 400000);
484 ret = clk_set_rate(host->mmc_clk, host->mmc->f_min);
485 if (ret)
486 return ret;
488 return clk_prepare_enable(host->mmc_clk);
491 static void meson_mmc_disable_resampling(struct meson_host *host)
493 unsigned int val = readl(host->regs + host->data->adjust);
495 val &= ~ADJUST_ADJ_EN;
496 writel(val, host->regs + host->data->adjust);
499 static void meson_mmc_reset_resampling(struct meson_host *host)
501 unsigned int val;
503 meson_mmc_disable_resampling(host);
505 val = readl(host->regs + host->data->adjust);
506 val &= ~ADJUST_ADJ_DELAY_MASK;
507 writel(val, host->regs + host->data->adjust);
510 static int meson_mmc_resampling_tuning(struct mmc_host *mmc, u32 opcode)
512 struct meson_host *host = mmc_priv(mmc);
513 unsigned int val, dly, max_dly, i;
514 int ret;
516 /* Resampling is done using the source clock */
517 max_dly = DIV_ROUND_UP(clk_get_rate(host->mux_clk),
518 clk_get_rate(host->mmc_clk));
520 val = readl(host->regs + host->data->adjust);
521 val |= ADJUST_ADJ_EN;
522 writel(val, host->regs + host->data->adjust);
524 if (mmc->doing_retune)
525 dly = FIELD_GET(ADJUST_ADJ_DELAY_MASK, val) + 1;
526 else
527 dly = 0;
529 for (i = 0; i < max_dly; i++) {
530 val &= ~ADJUST_ADJ_DELAY_MASK;
531 val |= FIELD_PREP(ADJUST_ADJ_DELAY_MASK, (dly + i) % max_dly);
532 writel(val, host->regs + host->data->adjust);
534 ret = mmc_send_tuning(mmc, opcode, NULL);
535 if (!ret) {
536 dev_dbg(mmc_dev(mmc), "resampling delay: %u\n",
537 (dly + i) % max_dly);
538 return 0;
542 meson_mmc_reset_resampling(host);
543 return -EIO;
546 static int meson_mmc_prepare_ios_clock(struct meson_host *host,
547 struct mmc_ios *ios)
549 bool ddr;
551 switch (ios->timing) {
552 case MMC_TIMING_MMC_DDR52:
553 case MMC_TIMING_UHS_DDR50:
554 ddr = true;
555 break;
557 default:
558 ddr = false;
559 break;
562 return meson_mmc_clk_set(host, ios->clock, ddr);
565 static void meson_mmc_check_resampling(struct meson_host *host,
566 struct mmc_ios *ios)
568 switch (ios->timing) {
569 case MMC_TIMING_LEGACY:
570 case MMC_TIMING_MMC_HS:
571 case MMC_TIMING_SD_HS:
572 case MMC_TIMING_MMC_DDR52:
573 meson_mmc_disable_resampling(host);
574 break;
578 static void meson_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
580 struct meson_host *host = mmc_priv(mmc);
581 u32 bus_width, val;
582 int err;
585 * GPIO regulator, only controls switching between 1v8 and
586 * 3v3, doesn't support MMC_POWER_OFF, MMC_POWER_ON.
588 switch (ios->power_mode) {
589 case MMC_POWER_OFF:
590 if (!IS_ERR(mmc->supply.vmmc))
591 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, 0);
593 if (!IS_ERR(mmc->supply.vqmmc) && host->vqmmc_enabled) {
594 regulator_disable(mmc->supply.vqmmc);
595 host->vqmmc_enabled = false;
598 break;
600 case MMC_POWER_UP:
601 if (!IS_ERR(mmc->supply.vmmc))
602 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, ios->vdd);
604 break;
606 case MMC_POWER_ON:
607 if (!IS_ERR(mmc->supply.vqmmc) && !host->vqmmc_enabled) {
608 int ret = regulator_enable(mmc->supply.vqmmc);
610 if (ret < 0)
611 dev_err(host->dev,
612 "failed to enable vqmmc regulator\n");
613 else
614 host->vqmmc_enabled = true;
617 break;
620 /* Bus width */
621 switch (ios->bus_width) {
622 case MMC_BUS_WIDTH_1:
623 bus_width = CFG_BUS_WIDTH_1;
624 break;
625 case MMC_BUS_WIDTH_4:
626 bus_width = CFG_BUS_WIDTH_4;
627 break;
628 case MMC_BUS_WIDTH_8:
629 bus_width = CFG_BUS_WIDTH_8;
630 break;
631 default:
632 dev_err(host->dev, "Invalid ios->bus_width: %u. Setting to 4.\n",
633 ios->bus_width);
634 bus_width = CFG_BUS_WIDTH_4;
637 val = readl(host->regs + SD_EMMC_CFG);
638 val &= ~CFG_BUS_WIDTH_MASK;
639 val |= FIELD_PREP(CFG_BUS_WIDTH_MASK, bus_width);
640 writel(val, host->regs + SD_EMMC_CFG);
642 meson_mmc_check_resampling(host, ios);
643 err = meson_mmc_prepare_ios_clock(host, ios);
644 if (err)
645 dev_err(host->dev, "Failed to set clock: %d\n,", err);
647 dev_dbg(host->dev, "SD_EMMC_CFG: 0x%08x\n", val);
650 static void meson_mmc_request_done(struct mmc_host *mmc,
651 struct mmc_request *mrq)
653 struct meson_host *host = mmc_priv(mmc);
655 host->cmd = NULL;
656 mmc_request_done(host->mmc, mrq);
659 static void meson_mmc_set_blksz(struct mmc_host *mmc, unsigned int blksz)
661 struct meson_host *host = mmc_priv(mmc);
662 u32 cfg, blksz_old;
664 cfg = readl(host->regs + SD_EMMC_CFG);
665 blksz_old = FIELD_GET(CFG_BLK_LEN_MASK, cfg);
667 if (!is_power_of_2(blksz))
668 dev_err(host->dev, "blksz %u is not a power of 2\n", blksz);
670 blksz = ilog2(blksz);
672 /* check if block-size matches, if not update */
673 if (blksz == blksz_old)
674 return;
676 dev_dbg(host->dev, "%s: update blk_len %d -> %d\n", __func__,
677 blksz_old, blksz);
679 cfg &= ~CFG_BLK_LEN_MASK;
680 cfg |= FIELD_PREP(CFG_BLK_LEN_MASK, blksz);
681 writel(cfg, host->regs + SD_EMMC_CFG);
684 static void meson_mmc_set_response_bits(struct mmc_command *cmd, u32 *cmd_cfg)
686 if (cmd->flags & MMC_RSP_PRESENT) {
687 if (cmd->flags & MMC_RSP_136)
688 *cmd_cfg |= CMD_CFG_RESP_128;
689 *cmd_cfg |= CMD_CFG_RESP_NUM;
691 if (!(cmd->flags & MMC_RSP_CRC))
692 *cmd_cfg |= CMD_CFG_RESP_NOCRC;
694 if (cmd->flags & MMC_RSP_BUSY)
695 *cmd_cfg |= CMD_CFG_R1B;
696 } else {
697 *cmd_cfg |= CMD_CFG_NO_RESP;
701 static void meson_mmc_desc_chain_transfer(struct mmc_host *mmc, u32 cmd_cfg)
703 struct meson_host *host = mmc_priv(mmc);
704 struct sd_emmc_desc *desc = host->descs;
705 struct mmc_data *data = host->cmd->data;
706 struct scatterlist *sg;
707 u32 start;
708 int i;
710 if (data->flags & MMC_DATA_WRITE)
711 cmd_cfg |= CMD_CFG_DATA_WR;
713 if (data->blocks > 1) {
714 cmd_cfg |= CMD_CFG_BLOCK_MODE;
715 meson_mmc_set_blksz(mmc, data->blksz);
718 for_each_sg(data->sg, sg, data->sg_count, i) {
719 unsigned int len = sg_dma_len(sg);
721 if (data->blocks > 1)
722 len /= data->blksz;
724 desc[i].cmd_cfg = cmd_cfg;
725 desc[i].cmd_cfg |= FIELD_PREP(CMD_CFG_LENGTH_MASK, len);
726 if (i > 0)
727 desc[i].cmd_cfg |= CMD_CFG_NO_CMD;
728 desc[i].cmd_arg = host->cmd->arg;
729 desc[i].cmd_resp = 0;
730 desc[i].cmd_data = sg_dma_address(sg);
732 desc[data->sg_count - 1].cmd_cfg |= CMD_CFG_END_OF_CHAIN;
734 dma_wmb(); /* ensure descriptor is written before kicked */
735 start = host->descs_dma_addr | START_DESC_BUSY;
736 writel(start, host->regs + SD_EMMC_START);
739 static void meson_mmc_start_cmd(struct mmc_host *mmc, struct mmc_command *cmd)
741 struct meson_host *host = mmc_priv(mmc);
742 struct mmc_data *data = cmd->data;
743 u32 cmd_cfg = 0, cmd_data = 0;
744 unsigned int xfer_bytes = 0;
746 /* Setup descriptors */
747 dma_rmb();
749 host->cmd = cmd;
751 cmd_cfg |= FIELD_PREP(CMD_CFG_CMD_INDEX_MASK, cmd->opcode);
752 cmd_cfg |= CMD_CFG_OWNER; /* owned by CPU */
753 cmd_cfg |= CMD_CFG_ERROR; /* stop in case of error */
755 meson_mmc_set_response_bits(cmd, &cmd_cfg);
757 /* data? */
758 if (data) {
759 data->bytes_xfered = 0;
760 cmd_cfg |= CMD_CFG_DATA_IO;
761 cmd_cfg |= FIELD_PREP(CMD_CFG_TIMEOUT_MASK,
762 ilog2(meson_mmc_get_timeout_msecs(data)));
764 if (meson_mmc_desc_chain_mode(data)) {
765 meson_mmc_desc_chain_transfer(mmc, cmd_cfg);
766 return;
769 if (data->blocks > 1) {
770 cmd_cfg |= CMD_CFG_BLOCK_MODE;
771 cmd_cfg |= FIELD_PREP(CMD_CFG_LENGTH_MASK,
772 data->blocks);
773 meson_mmc_set_blksz(mmc, data->blksz);
774 } else {
775 cmd_cfg |= FIELD_PREP(CMD_CFG_LENGTH_MASK, data->blksz);
778 xfer_bytes = data->blksz * data->blocks;
779 if (data->flags & MMC_DATA_WRITE) {
780 cmd_cfg |= CMD_CFG_DATA_WR;
781 WARN_ON(xfer_bytes > host->bounce_buf_size);
782 sg_copy_to_buffer(data->sg, data->sg_len,
783 host->bounce_buf, xfer_bytes);
784 dma_wmb();
787 cmd_data = host->bounce_dma_addr & CMD_DATA_MASK;
788 } else {
789 cmd_cfg |= FIELD_PREP(CMD_CFG_TIMEOUT_MASK,
790 ilog2(SD_EMMC_CMD_TIMEOUT));
793 /* Last descriptor */
794 cmd_cfg |= CMD_CFG_END_OF_CHAIN;
795 writel(cmd_cfg, host->regs + SD_EMMC_CMD_CFG);
796 writel(cmd_data, host->regs + SD_EMMC_CMD_DAT);
797 writel(0, host->regs + SD_EMMC_CMD_RSP);
798 wmb(); /* ensure descriptor is written before kicked */
799 writel(cmd->arg, host->regs + SD_EMMC_CMD_ARG);
802 static void meson_mmc_request(struct mmc_host *mmc, struct mmc_request *mrq)
804 struct meson_host *host = mmc_priv(mmc);
805 bool needs_pre_post_req = mrq->data &&
806 !(mrq->data->host_cookie & SD_EMMC_PRE_REQ_DONE);
808 if (needs_pre_post_req) {
809 meson_mmc_get_transfer_mode(mmc, mrq);
810 if (!meson_mmc_desc_chain_mode(mrq->data))
811 needs_pre_post_req = false;
814 if (needs_pre_post_req)
815 meson_mmc_pre_req(mmc, mrq);
817 /* Stop execution */
818 writel(0, host->regs + SD_EMMC_START);
820 meson_mmc_start_cmd(mmc, mrq->sbc ?: mrq->cmd);
822 if (needs_pre_post_req)
823 meson_mmc_post_req(mmc, mrq, 0);
826 static void meson_mmc_read_resp(struct mmc_host *mmc, struct mmc_command *cmd)
828 struct meson_host *host = mmc_priv(mmc);
830 if (cmd->flags & MMC_RSP_136) {
831 cmd->resp[0] = readl(host->regs + SD_EMMC_CMD_RSP3);
832 cmd->resp[1] = readl(host->regs + SD_EMMC_CMD_RSP2);
833 cmd->resp[2] = readl(host->regs + SD_EMMC_CMD_RSP1);
834 cmd->resp[3] = readl(host->regs + SD_EMMC_CMD_RSP);
835 } else if (cmd->flags & MMC_RSP_PRESENT) {
836 cmd->resp[0] = readl(host->regs + SD_EMMC_CMD_RSP);
840 static irqreturn_t meson_mmc_irq(int irq, void *dev_id)
842 struct meson_host *host = dev_id;
843 struct mmc_command *cmd;
844 struct mmc_data *data;
845 u32 irq_en, status, raw_status;
846 irqreturn_t ret = IRQ_NONE;
848 irq_en = readl(host->regs + SD_EMMC_IRQ_EN);
849 raw_status = readl(host->regs + SD_EMMC_STATUS);
850 status = raw_status & irq_en;
852 if (!status) {
853 dev_dbg(host->dev,
854 "Unexpected IRQ! irq_en 0x%08x - status 0x%08x\n",
855 irq_en, raw_status);
856 return IRQ_NONE;
859 if (WARN_ON(!host) || WARN_ON(!host->cmd))
860 return IRQ_NONE;
862 /* ack all raised interrupts */
863 writel(status, host->regs + SD_EMMC_STATUS);
865 cmd = host->cmd;
866 data = cmd->data;
867 cmd->error = 0;
868 if (status & IRQ_CRC_ERR) {
869 dev_dbg(host->dev, "CRC Error - status 0x%08x\n", status);
870 cmd->error = -EILSEQ;
871 ret = IRQ_WAKE_THREAD;
872 goto out;
875 if (status & IRQ_TIMEOUTS) {
876 dev_dbg(host->dev, "Timeout - status 0x%08x\n", status);
877 cmd->error = -ETIMEDOUT;
878 ret = IRQ_WAKE_THREAD;
879 goto out;
882 meson_mmc_read_resp(host->mmc, cmd);
884 if (status & IRQ_SDIO) {
885 dev_dbg(host->dev, "IRQ: SDIO TODO.\n");
886 ret = IRQ_HANDLED;
889 if (status & (IRQ_END_OF_CHAIN | IRQ_RESP_STATUS)) {
890 if (data && !cmd->error)
891 data->bytes_xfered = data->blksz * data->blocks;
892 if (meson_mmc_bounce_buf_read(data) ||
893 meson_mmc_get_next_command(cmd))
894 ret = IRQ_WAKE_THREAD;
895 else
896 ret = IRQ_HANDLED;
899 out:
900 if (cmd->error) {
901 /* Stop desc in case of errors */
902 u32 start = readl(host->regs + SD_EMMC_START);
904 start &= ~START_DESC_BUSY;
905 writel(start, host->regs + SD_EMMC_START);
908 if (ret == IRQ_HANDLED)
909 meson_mmc_request_done(host->mmc, cmd->mrq);
911 return ret;
914 static int meson_mmc_wait_desc_stop(struct meson_host *host)
916 u32 status;
919 * It may sometimes take a while for it to actually halt. Here, we
920 * are giving it 5ms to comply
922 * If we don't confirm the descriptor is stopped, it might raise new
923 * IRQs after we have called mmc_request_done() which is bad.
926 return readl_poll_timeout(host->regs + SD_EMMC_STATUS, status,
927 !(status & (STATUS_BUSY | STATUS_DESC_BUSY)),
928 100, 5000);
931 static irqreturn_t meson_mmc_irq_thread(int irq, void *dev_id)
933 struct meson_host *host = dev_id;
934 struct mmc_command *next_cmd, *cmd = host->cmd;
935 struct mmc_data *data;
936 unsigned int xfer_bytes;
938 if (WARN_ON(!cmd))
939 return IRQ_NONE;
941 if (cmd->error) {
942 meson_mmc_wait_desc_stop(host);
943 meson_mmc_request_done(host->mmc, cmd->mrq);
945 return IRQ_HANDLED;
948 data = cmd->data;
949 if (meson_mmc_bounce_buf_read(data)) {
950 xfer_bytes = data->blksz * data->blocks;
951 WARN_ON(xfer_bytes > host->bounce_buf_size);
952 sg_copy_from_buffer(data->sg, data->sg_len,
953 host->bounce_buf, xfer_bytes);
956 next_cmd = meson_mmc_get_next_command(cmd);
957 if (next_cmd)
958 meson_mmc_start_cmd(host->mmc, next_cmd);
959 else
960 meson_mmc_request_done(host->mmc, cmd->mrq);
962 return IRQ_HANDLED;
966 * NOTE: we only need this until the GPIO/pinctrl driver can handle
967 * interrupts. For now, the MMC core will use this for polling.
969 static int meson_mmc_get_cd(struct mmc_host *mmc)
971 int status = mmc_gpio_get_cd(mmc);
973 if (status == -ENOSYS)
974 return 1; /* assume present */
976 return status;
979 static void meson_mmc_cfg_init(struct meson_host *host)
981 u32 cfg = 0;
983 cfg |= FIELD_PREP(CFG_RESP_TIMEOUT_MASK,
984 ilog2(SD_EMMC_CFG_RESP_TIMEOUT));
985 cfg |= FIELD_PREP(CFG_RC_CC_MASK, ilog2(SD_EMMC_CFG_CMD_GAP));
986 cfg |= FIELD_PREP(CFG_BLK_LEN_MASK, ilog2(SD_EMMC_CFG_BLK_SIZE));
988 /* abort chain on R/W errors */
989 cfg |= CFG_ERR_ABORT;
991 writel(cfg, host->regs + SD_EMMC_CFG);
994 static int meson_mmc_card_busy(struct mmc_host *mmc)
996 struct meson_host *host = mmc_priv(mmc);
997 u32 regval;
999 regval = readl(host->regs + SD_EMMC_STATUS);
1001 /* We are only interrested in lines 0 to 3, so mask the other ones */
1002 return !(FIELD_GET(STATUS_DATI, regval) & 0xf);
1005 static int meson_mmc_voltage_switch(struct mmc_host *mmc, struct mmc_ios *ios)
1007 /* vqmmc regulator is available */
1008 if (!IS_ERR(mmc->supply.vqmmc)) {
1010 * The usual amlogic setup uses a GPIO to switch from one
1011 * regulator to the other. While the voltage ramp up is
1012 * pretty fast, care must be taken when switching from 3.3v
1013 * to 1.8v. Please make sure the regulator framework is aware
1014 * of your own regulator constraints
1016 return mmc_regulator_set_vqmmc(mmc, ios);
1019 /* no vqmmc regulator, assume fixed regulator at 3/3.3V */
1020 if (ios->signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1021 return 0;
1023 return -EINVAL;
1026 static const struct mmc_host_ops meson_mmc_ops = {
1027 .request = meson_mmc_request,
1028 .set_ios = meson_mmc_set_ios,
1029 .get_cd = meson_mmc_get_cd,
1030 .pre_req = meson_mmc_pre_req,
1031 .post_req = meson_mmc_post_req,
1032 .execute_tuning = meson_mmc_resampling_tuning,
1033 .card_busy = meson_mmc_card_busy,
1034 .start_signal_voltage_switch = meson_mmc_voltage_switch,
1037 static int meson_mmc_probe(struct platform_device *pdev)
1039 struct resource *res;
1040 struct meson_host *host;
1041 struct mmc_host *mmc;
1042 int ret;
1044 mmc = mmc_alloc_host(sizeof(struct meson_host), &pdev->dev);
1045 if (!mmc)
1046 return -ENOMEM;
1047 host = mmc_priv(mmc);
1048 host->mmc = mmc;
1049 host->dev = &pdev->dev;
1050 dev_set_drvdata(&pdev->dev, host);
1052 /* The G12A SDIO Controller needs an SRAM bounce buffer */
1053 host->dram_access_quirk = device_property_read_bool(&pdev->dev,
1054 "amlogic,dram-access-quirk");
1056 /* Get regulators and the supported OCR mask */
1057 host->vqmmc_enabled = false;
1058 ret = mmc_regulator_get_supply(mmc);
1059 if (ret)
1060 goto free_host;
1062 ret = mmc_of_parse(mmc);
1063 if (ret) {
1064 if (ret != -EPROBE_DEFER)
1065 dev_warn(&pdev->dev, "error parsing DT: %d\n", ret);
1066 goto free_host;
1069 host->data = (struct meson_mmc_data *)
1070 of_device_get_match_data(&pdev->dev);
1071 if (!host->data) {
1072 ret = -EINVAL;
1073 goto free_host;
1076 ret = device_reset_optional(&pdev->dev);
1077 if (ret) {
1078 if (ret != -EPROBE_DEFER)
1079 dev_err(&pdev->dev, "device reset failed: %d\n", ret);
1081 return ret;
1084 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1085 host->regs = devm_ioremap_resource(&pdev->dev, res);
1086 if (IS_ERR(host->regs)) {
1087 ret = PTR_ERR(host->regs);
1088 goto free_host;
1091 host->irq = platform_get_irq(pdev, 0);
1092 if (host->irq <= 0) {
1093 ret = -EINVAL;
1094 goto free_host;
1097 host->pinctrl = devm_pinctrl_get(&pdev->dev);
1098 if (IS_ERR(host->pinctrl)) {
1099 ret = PTR_ERR(host->pinctrl);
1100 goto free_host;
1103 host->pins_clk_gate = pinctrl_lookup_state(host->pinctrl,
1104 "clk-gate");
1105 if (IS_ERR(host->pins_clk_gate)) {
1106 dev_warn(&pdev->dev,
1107 "can't get clk-gate pinctrl, using clk_stop bit\n");
1108 host->pins_clk_gate = NULL;
1111 host->core_clk = devm_clk_get(&pdev->dev, "core");
1112 if (IS_ERR(host->core_clk)) {
1113 ret = PTR_ERR(host->core_clk);
1114 goto free_host;
1117 ret = clk_prepare_enable(host->core_clk);
1118 if (ret)
1119 goto free_host;
1121 ret = meson_mmc_clk_init(host);
1122 if (ret)
1123 goto err_core_clk;
1125 /* set config to sane default */
1126 meson_mmc_cfg_init(host);
1128 /* Stop execution */
1129 writel(0, host->regs + SD_EMMC_START);
1131 /* clear, ack and enable interrupts */
1132 writel(0, host->regs + SD_EMMC_IRQ_EN);
1133 writel(IRQ_CRC_ERR | IRQ_TIMEOUTS | IRQ_END_OF_CHAIN,
1134 host->regs + SD_EMMC_STATUS);
1135 writel(IRQ_CRC_ERR | IRQ_TIMEOUTS | IRQ_END_OF_CHAIN,
1136 host->regs + SD_EMMC_IRQ_EN);
1138 ret = request_threaded_irq(host->irq, meson_mmc_irq,
1139 meson_mmc_irq_thread, IRQF_ONESHOT,
1140 dev_name(&pdev->dev), host);
1141 if (ret)
1142 goto err_init_clk;
1144 mmc->caps |= MMC_CAP_CMD23;
1145 if (host->dram_access_quirk) {
1146 /* Limit to the available sram memory */
1147 mmc->max_segs = SD_EMMC_SRAM_DATA_BUF_LEN / mmc->max_blk_size;
1148 mmc->max_blk_count = mmc->max_segs;
1149 } else {
1150 mmc->max_blk_count = CMD_CFG_LENGTH_MASK;
1151 mmc->max_segs = SD_EMMC_DESC_BUF_LEN /
1152 sizeof(struct sd_emmc_desc);
1154 mmc->max_req_size = mmc->max_blk_count * mmc->max_blk_size;
1155 mmc->max_seg_size = mmc->max_req_size;
1158 * At the moment, we don't know how to reliably enable HS400.
1159 * From the different datasheets, it is not even clear if this mode
1160 * is officially supported by any of the SoCs
1162 mmc->caps2 &= ~MMC_CAP2_HS400;
1164 if (host->dram_access_quirk) {
1166 * The MMC Controller embeds 1,5KiB of internal SRAM
1167 * that can be used to be used as bounce buffer.
1168 * In the case of the G12A SDIO controller, use these
1169 * instead of the DDR memory
1171 host->bounce_buf_size = SD_EMMC_SRAM_DATA_BUF_LEN;
1172 host->bounce_buf = host->regs + SD_EMMC_SRAM_DATA_BUF_OFF;
1173 host->bounce_dma_addr = res->start + SD_EMMC_SRAM_DATA_BUF_OFF;
1174 } else {
1175 /* data bounce buffer */
1176 host->bounce_buf_size = mmc->max_req_size;
1177 host->bounce_buf =
1178 dma_alloc_coherent(host->dev, host->bounce_buf_size,
1179 &host->bounce_dma_addr, GFP_KERNEL);
1180 if (host->bounce_buf == NULL) {
1181 dev_err(host->dev, "Unable to map allocate DMA bounce buffer.\n");
1182 ret = -ENOMEM;
1183 goto err_free_irq;
1187 host->descs = dma_alloc_coherent(host->dev, SD_EMMC_DESC_BUF_LEN,
1188 &host->descs_dma_addr, GFP_KERNEL);
1189 if (!host->descs) {
1190 dev_err(host->dev, "Allocating descriptor DMA buffer failed\n");
1191 ret = -ENOMEM;
1192 goto err_bounce_buf;
1195 mmc->ops = &meson_mmc_ops;
1196 mmc_add_host(mmc);
1198 return 0;
1200 err_bounce_buf:
1201 if (!host->dram_access_quirk)
1202 dma_free_coherent(host->dev, host->bounce_buf_size,
1203 host->bounce_buf, host->bounce_dma_addr);
1204 err_free_irq:
1205 free_irq(host->irq, host);
1206 err_init_clk:
1207 clk_disable_unprepare(host->mmc_clk);
1208 err_core_clk:
1209 clk_disable_unprepare(host->core_clk);
1210 free_host:
1211 mmc_free_host(mmc);
1212 return ret;
1215 static int meson_mmc_remove(struct platform_device *pdev)
1217 struct meson_host *host = dev_get_drvdata(&pdev->dev);
1219 mmc_remove_host(host->mmc);
1221 /* disable interrupts */
1222 writel(0, host->regs + SD_EMMC_IRQ_EN);
1223 free_irq(host->irq, host);
1225 dma_free_coherent(host->dev, SD_EMMC_DESC_BUF_LEN,
1226 host->descs, host->descs_dma_addr);
1228 if (!host->dram_access_quirk)
1229 dma_free_coherent(host->dev, host->bounce_buf_size,
1230 host->bounce_buf, host->bounce_dma_addr);
1232 clk_disable_unprepare(host->mmc_clk);
1233 clk_disable_unprepare(host->core_clk);
1235 mmc_free_host(host->mmc);
1236 return 0;
1239 static const struct meson_mmc_data meson_gx_data = {
1240 .tx_delay_mask = CLK_V2_TX_DELAY_MASK,
1241 .rx_delay_mask = CLK_V2_RX_DELAY_MASK,
1242 .always_on = CLK_V2_ALWAYS_ON,
1243 .adjust = SD_EMMC_ADJUST,
1246 static const struct meson_mmc_data meson_axg_data = {
1247 .tx_delay_mask = CLK_V3_TX_DELAY_MASK,
1248 .rx_delay_mask = CLK_V3_RX_DELAY_MASK,
1249 .always_on = CLK_V3_ALWAYS_ON,
1250 .adjust = SD_EMMC_V3_ADJUST,
1253 static const struct of_device_id meson_mmc_of_match[] = {
1254 { .compatible = "amlogic,meson-gx-mmc", .data = &meson_gx_data },
1255 { .compatible = "amlogic,meson-gxbb-mmc", .data = &meson_gx_data },
1256 { .compatible = "amlogic,meson-gxl-mmc", .data = &meson_gx_data },
1257 { .compatible = "amlogic,meson-gxm-mmc", .data = &meson_gx_data },
1258 { .compatible = "amlogic,meson-axg-mmc", .data = &meson_axg_data },
1261 MODULE_DEVICE_TABLE(of, meson_mmc_of_match);
1263 static struct platform_driver meson_mmc_driver = {
1264 .probe = meson_mmc_probe,
1265 .remove = meson_mmc_remove,
1266 .driver = {
1267 .name = DRIVER_NAME,
1268 .of_match_table = of_match_ptr(meson_mmc_of_match),
1272 module_platform_driver(meson_mmc_driver);
1274 MODULE_DESCRIPTION("Amlogic S905*/GX*/AXG SD/eMMC driver");
1275 MODULE_AUTHOR("Kevin Hilman <khilman@baylibre.com>");
1276 MODULE_LICENSE("GPL v2");