1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2016 Fuzhou Rockchip Electronics Co., Ltd
5 * Rockchip SD Host Controller Interface
11 #include <dm/ofnode.h>
12 #include <dt-structs.h>
13 #include <linux/delay.h>
14 #include <linux/err.h>
15 #include <linux/libfdt.h>
16 #include <linux/iopoll.h>
19 #include "mmc_private.h"
22 #include <asm/arch-rockchip/clock.h>
23 #include <asm/arch-rockchip/hardware.h>
25 /* DWCMSHC specific Mode Select value */
26 #define DWCMSHC_CTRL_HS400 0x7
27 /* 400KHz is max freq for card ID etc. Use that as min */
28 #define EMMC_MIN_FREQ 400000
30 #define MHz (1000 * KHz)
31 #define SDHCI_TUNING_LOOP_COUNT 40
33 #define PHYCTRL_CALDONE_MASK 0x1
34 #define PHYCTRL_CALDONE_SHIFT 0x6
35 #define PHYCTRL_CALDONE_DONE 0x1
36 #define PHYCTRL_DLLRDY_MASK 0x1
37 #define PHYCTRL_DLLRDY_SHIFT 0x5
38 #define PHYCTRL_DLLRDY_DONE 0x1
39 #define PHYCTRL_FREQSEL_200M 0x0
40 #define PHYCTRL_FREQSEL_50M 0x1
41 #define PHYCTRL_FREQSEL_100M 0x2
42 #define PHYCTRL_FREQSEL_150M 0x3
43 #define PHYCTRL_DLL_LOCK_WO_TMOUT(x) \
44 ((((x) >> PHYCTRL_DLLRDY_SHIFT) & PHYCTRL_DLLRDY_MASK) ==\
47 #define ARASAN_VENDOR_REGISTER 0x78
48 #define ARASAN_VENDOR_ENHANCED_STROBE BIT(0)
50 /* DWC IP vendor area 1 pointer */
51 #define DWCMSHC_P_VENDOR_AREA1 0xe8
52 #define DWCMSHC_AREA1_MASK GENMASK(11, 0)
53 /* Offset inside the vendor area 1 */
54 #define DWCMSHC_EMMC_CONTROL 0x2c
55 #define DWCMSHC_CARD_IS_EMMC BIT(0)
56 #define DWCMSHC_ENHANCED_STROBE BIT(8)
58 /* Rockchip specific Registers */
59 #define DWCMSHC_EMMC_DLL_CTRL 0x800
60 #define DWCMSHC_EMMC_DLL_CTRL_RESET BIT(1)
61 #define DWCMSHC_EMMC_DLL_RXCLK 0x804
62 #define DWCMSHC_EMMC_DLL_TXCLK 0x808
63 #define DWCMSHC_EMMC_DLL_STRBIN 0x80c
64 #define DECMSHC_EMMC_DLL_CMDOUT 0x810
65 #define DWCMSHC_EMMC_DLL_STATUS0 0x840
66 #define DWCMSHC_EMMC_DLL_STATUS1 0x844
67 #define DWCMSHC_EMMC_DLL_START BIT(0)
68 #define DWCMSHC_EMMC_DLL_RXCLK_SRCSEL 29
69 #define DWCMSHC_EMMC_DLL_START_POINT 16
70 #define DWCMSHC_EMMC_DLL_START_DEFAULT 5
71 #define DWCMSHC_EMMC_DLL_INC_VALUE 2
72 #define DWCMSHC_EMMC_DLL_INC 8
73 #define DWCMSHC_EMMC_DLL_BYPASS BIT(24)
74 #define DWCMSHC_EMMC_DLL_DLYENA BIT(27)
75 #define DLL_TXCLK_TAPNUM_DEFAULT 0xA
77 #define DLL_STRBIN_TAPNUM_DEFAULT 0x8
78 #define DLL_STRBIN_TAPNUM_FROM_SW BIT(24)
79 #define DLL_STRBIN_DELAY_NUM_SEL BIT(26)
80 #define DLL_STRBIN_DELAY_NUM_OFFSET 16
81 #define DLL_STRBIN_DELAY_NUM_DEFAULT 0x16
83 #define DLL_TXCLK_TAPNUM_FROM_SW BIT(24)
84 #define DWCMSHC_EMMC_DLL_LOCKED BIT(8)
85 #define DWCMSHC_EMMC_DLL_TIMEOUT BIT(9)
86 #define DLL_RXCLK_NO_INVERTER 1
87 #define DLL_RXCLK_INVERTER 0
88 #define DLL_RXCLK_ORI_GATE BIT(31)
89 #define DWCMSHC_ENHANCED_STROBE BIT(8)
90 #define DLL_LOCK_WO_TMOUT(x) \
91 ((((x) & DWCMSHC_EMMC_DLL_LOCKED) == DWCMSHC_EMMC_DLL_LOCKED) && \
92 (((x) & DWCMSHC_EMMC_DLL_TIMEOUT) == 0))
93 #define ROCKCHIP_MAX_CLKS 3
95 struct rockchip_sdhc_plat {
96 struct mmc_config cfg;
100 struct rockchip_emmc_phy {
106 struct rockchip_sdhc {
107 struct sdhci_host host;
110 struct rockchip_emmc_phy *phy;
115 int (*get_phy)(struct udevice *dev);
118 * set_control_reg() - Set SDHCI control registers
120 * This is the set_control_reg() SDHCI operation that should be
121 * used for the hardware this driver data is associated with.
122 * Normally, this is used to set up control registers for
123 * voltage level and UHS speed mode.
125 * @host: SDHCI host structure
127 void (*set_control_reg)(struct sdhci_host *host);
130 * set_ios_post() - Host specific hook after set_ios() calls
132 * This is the set_ios_post() SDHCI operation that should be
133 * used for the hardware this driver data is associated with.
134 * Normally, this is a hook that is called after sdhci_set_ios()
135 * that does any necessary host-specific configuration.
137 * @host: SDHCI host structure
138 * Return: 0 if successful, -ve on error
140 int (*set_ios_post)(struct sdhci_host *host);
142 void (*set_clock)(struct sdhci_host *host, u32 div);
143 int (*config_dll)(struct sdhci_host *host, u32 clock, bool enable);
146 * set_enhanced_strobe() - Set HS400 Enhanced Strobe config
148 * This is the set_enhanced_strobe() SDHCI operation that should
149 * be used for the hardware this driver data is associated with.
150 * Normally, this is used to set any host-specific configuration
151 * necessary for HS400 ES.
153 * @host: SDHCI host structure
154 * Return: 0 if successful, -ve on error
156 int (*set_enhanced_strobe)(struct sdhci_host *host);
159 static void rk3399_emmc_phy_power_on(struct rockchip_emmc_phy *phy, u32 clock)
161 u32 caldone, dllrdy, freqsel;
163 writel(RK_CLRSETBITS(7 << 4, 0), &phy->emmcphy_con[6]);
164 writel(RK_CLRSETBITS(1 << 11, 1 << 11), &phy->emmcphy_con[0]);
165 writel(RK_CLRSETBITS(0xf << 7, 6 << 7), &phy->emmcphy_con[0]);
168 * According to the user manual, calpad calibration
169 * cycle takes more than 2us without the minimal recommended
170 * value, so we may need a little margin here
173 writel(RK_CLRSETBITS(1, 1), &phy->emmcphy_con[6]);
176 * According to the user manual, it asks driver to
177 * wait 5us for calpad busy trimming. But it seems that
178 * 5us of caldone isn't enough for all cases.
181 caldone = readl(&phy->emmcphy_status);
182 caldone = (caldone >> PHYCTRL_CALDONE_SHIFT) & PHYCTRL_CALDONE_MASK;
183 if (caldone != PHYCTRL_CALDONE_DONE) {
184 printf("%s: caldone timeout.\n", __func__);
188 /* Set the frequency of the DLL operation */
189 if (clock < 75 * MHz)
190 freqsel = PHYCTRL_FREQSEL_50M;
191 else if (clock < 125 * MHz)
192 freqsel = PHYCTRL_FREQSEL_100M;
193 else if (clock < 175 * MHz)
194 freqsel = PHYCTRL_FREQSEL_150M;
196 freqsel = PHYCTRL_FREQSEL_200M;
198 /* Set the frequency of the DLL operation */
199 writel(RK_CLRSETBITS(3 << 12, freqsel << 12), &phy->emmcphy_con[0]);
200 writel(RK_CLRSETBITS(1 << 1, 1 << 1), &phy->emmcphy_con[6]);
202 /* REN Enable on STRB Line for HS400 */
203 writel(RK_CLRSETBITS(0, 1 << 9), &phy->emmcphy_con[2]);
205 read_poll_timeout(readl, dllrdy, PHYCTRL_DLL_LOCK_WO_TMOUT(dllrdy), 1,
206 5000, &phy->emmcphy_status);
209 static void rk3399_emmc_phy_power_off(struct rockchip_emmc_phy *phy)
211 writel(RK_CLRSETBITS(1, 0), &phy->emmcphy_con[6]);
212 writel(RK_CLRSETBITS(1 << 1, 0), &phy->emmcphy_con[6]);
215 static int rk3399_emmc_get_phy(struct udevice *dev)
217 struct rockchip_sdhc *priv = dev_get_priv(dev);
220 u32 grf_phy_offset, phandle;
222 phandle = dev_read_u32_default(dev, "phys", 0);
223 phy_node = ofnode_get_by_phandle(phandle);
224 if (!ofnode_valid(phy_node)) {
225 debug("Not found emmc phy device\n");
229 grf_base = syscon_get_first_range(ROCKCHIP_SYSCON_GRF);
230 if (IS_ERR_OR_NULL(grf_base)) {
231 printf("%s Get syscon grf failed", __func__);
234 grf_phy_offset = ofnode_read_u32_default(phy_node, "reg", 0);
236 priv->phy = (struct rockchip_emmc_phy *)(grf_base + grf_phy_offset);
241 static int rk3399_sdhci_set_enhanced_strobe(struct sdhci_host *host)
243 struct mmc *mmc = host->mmc;
246 vendor = sdhci_readl(host, ARASAN_VENDOR_REGISTER);
247 if (mmc->selected_mode == MMC_HS_400_ES)
248 vendor |= ARASAN_VENDOR_ENHANCED_STROBE;
250 vendor &= ~ARASAN_VENDOR_ENHANCED_STROBE;
251 sdhci_writel(host, vendor, ARASAN_VENDOR_REGISTER);
256 static void rk3399_sdhci_set_control_reg(struct sdhci_host *host)
258 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
259 struct mmc *mmc = host->mmc;
260 uint clock = mmc->tran_speed;
261 int cycle_phy = host->clock != clock && clock > EMMC_MIN_FREQ;
264 rk3399_emmc_phy_power_off(priv->phy);
266 sdhci_set_control_reg(host);
269 * Reinitializing the device tries to set it to lower-speed modes
270 * first, which fails if the Enhanced Strobe bit is set, making
271 * the device impossible to use. Set the correct value here to
272 * let reinitialization attempts succeed.
274 if (CONFIG_IS_ENABLED(MMC_HS400_ES_SUPPORT))
275 rk3399_sdhci_set_enhanced_strobe(host);
278 static int rk3399_sdhci_set_ios_post(struct sdhci_host *host)
280 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
281 struct mmc *mmc = host->mmc;
282 uint clock = mmc->tran_speed;
283 int cycle_phy = host->clock != clock && clock > EMMC_MIN_FREQ;
289 rk3399_emmc_phy_power_on(priv->phy, clock);
294 static void rk3568_sdhci_set_clock(struct sdhci_host *host, u32 div)
296 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
297 struct mmc *mmc = host->mmc;
300 rate = clk_set_rate(&priv->emmc_clk, mmc->clock);
301 if (IS_ERR_VALUE(rate))
302 printf("%s: Set clock rate failed: %ld\n", __func__, (long)rate);
305 static int rk3568_sdhci_config_dll(struct sdhci_host *host, u32 clock, bool enable)
313 if (clock >= 100 * MHz) {
315 sdhci_writel(host, DWCMSHC_EMMC_DLL_CTRL_RESET, DWCMSHC_EMMC_DLL_CTRL);
317 sdhci_writel(host, 0, DWCMSHC_EMMC_DLL_CTRL);
319 /* Init DLL settings */
320 extra = DWCMSHC_EMMC_DLL_START_DEFAULT << DWCMSHC_EMMC_DLL_START_POINT |
321 DWCMSHC_EMMC_DLL_INC_VALUE << DWCMSHC_EMMC_DLL_INC |
322 DWCMSHC_EMMC_DLL_START;
323 sdhci_writel(host, extra, DWCMSHC_EMMC_DLL_CTRL);
325 ret = read_poll_timeout(readl, val, DLL_LOCK_WO_TMOUT(val), 1,
327 host->ioaddr + DWCMSHC_EMMC_DLL_STATUS0);
331 extra = DWCMSHC_EMMC_DLL_DLYENA |
332 DLL_RXCLK_NO_INVERTER << DWCMSHC_EMMC_DLL_RXCLK_SRCSEL;
333 sdhci_writel(host, extra, DWCMSHC_EMMC_DLL_RXCLK);
335 extra = DWCMSHC_EMMC_DLL_DLYENA |
336 DLL_TXCLK_TAPNUM_DEFAULT |
337 DLL_TXCLK_TAPNUM_FROM_SW;
338 sdhci_writel(host, extra, DWCMSHC_EMMC_DLL_TXCLK);
340 extra = DWCMSHC_EMMC_DLL_DLYENA |
341 DLL_STRBIN_TAPNUM_DEFAULT |
342 DLL_STRBIN_TAPNUM_FROM_SW;
343 sdhci_writel(host, extra, DWCMSHC_EMMC_DLL_STRBIN);
346 * Disable DLL and reset both of sample and drive clock.
347 * The bypass bit and start bit need to be set if DLL is not locked.
349 sdhci_writel(host, DWCMSHC_EMMC_DLL_BYPASS | DWCMSHC_EMMC_DLL_START,
350 DWCMSHC_EMMC_DLL_CTRL);
351 sdhci_writel(host, DLL_RXCLK_ORI_GATE, DWCMSHC_EMMC_DLL_RXCLK);
352 sdhci_writel(host, 0, DECMSHC_EMMC_DLL_CMDOUT);
353 sdhci_writel(host, 0, DWCMSHC_EMMC_DLL_TXCLK);
355 * Before switching to hs400es mode, the driver will enable
356 * enhanced strobe first. PHY needs to configure the parameters
357 * of enhanced strobe first.
359 extra = DWCMSHC_EMMC_DLL_DLYENA |
360 DLL_STRBIN_DELAY_NUM_SEL |
361 DLL_STRBIN_DELAY_NUM_DEFAULT << DLL_STRBIN_DELAY_NUM_OFFSET;
362 sdhci_writel(host, extra, DWCMSHC_EMMC_DLL_STRBIN);
368 static int rk3568_emmc_get_phy(struct udevice *dev)
373 static int rk3568_sdhci_set_enhanced_strobe(struct sdhci_host *host)
375 struct mmc *mmc = host->mmc;
379 reg = (sdhci_readl(host, DWCMSHC_P_VENDOR_AREA1) & DWCMSHC_AREA1_MASK)
380 + DWCMSHC_EMMC_CONTROL;
382 vendor = sdhci_readl(host, reg);
383 if (mmc->selected_mode == MMC_HS_400_ES)
384 vendor |= DWCMSHC_ENHANCED_STROBE;
386 vendor &= ~DWCMSHC_ENHANCED_STROBE;
387 sdhci_writel(host, vendor, reg);
392 static int rk3568_sdhci_set_ios_post(struct sdhci_host *host)
394 struct mmc *mmc = host->mmc;
397 if (mmc->selected_mode == MMC_HS_400 || mmc->selected_mode == MMC_HS_400_ES) {
398 reg = sdhci_readw(host, SDHCI_HOST_CONTROL2);
399 reg &= ~SDHCI_CTRL_UHS_MASK;
400 reg |= DWCMSHC_CTRL_HS400;
401 sdhci_writew(host, reg, SDHCI_HOST_CONTROL2);
403 vendor_reg = (sdhci_readl(host, DWCMSHC_P_VENDOR_AREA1) & DWCMSHC_AREA1_MASK)
404 + DWCMSHC_EMMC_CONTROL;
405 /* set CARD_IS_EMMC bit to enable Data Strobe for HS400 */
406 reg = sdhci_readw(host, vendor_reg);
407 reg |= DWCMSHC_CARD_IS_EMMC;
408 sdhci_writew(host, reg, vendor_reg);
410 sdhci_set_uhs_timing(host);
416 static void rockchip_sdhci_set_control_reg(struct sdhci_host *host)
418 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
419 struct sdhci_data *data = (struct sdhci_data *)dev_get_driver_data(priv->dev);
421 if (data->set_control_reg)
422 data->set_control_reg(host);
425 static int rockchip_sdhci_set_ios_post(struct sdhci_host *host)
427 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
428 struct sdhci_data *data = (struct sdhci_data *)dev_get_driver_data(priv->dev);
430 if (data->set_ios_post)
431 return data->set_ios_post(host);
436 static void rockchip_sdhci_set_clock(struct sdhci_host *host, u32 div)
438 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
439 struct sdhci_data *data = (struct sdhci_data *)dev_get_driver_data(priv->dev);
442 data->set_clock(host, div);
445 static int rockchip_sdhci_execute_tuning(struct mmc *mmc, u8 opcode)
447 struct rockchip_sdhc *priv = dev_get_priv(mmc->dev);
448 struct sdhci_host *host = &priv->host;
449 char tuning_loop_counter = SDHCI_TUNING_LOOP_COUNT;
454 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2);
455 ctrl |= SDHCI_CTRL_EXEC_TUNING;
456 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2);
458 sdhci_writel(host, SDHCI_INT_DATA_AVAIL, SDHCI_INT_ENABLE);
460 blk_size = SDHCI_MAKE_BLKSZ(SDHCI_DEFAULT_BOUNDARY_ARG, 64);
461 if (opcode == MMC_CMD_SEND_TUNING_BLOCK_HS200 && mmc->bus_width == 8)
462 blk_size = SDHCI_MAKE_BLKSZ(SDHCI_DEFAULT_BOUNDARY_ARG, 128);
463 sdhci_writew(host, blk_size, SDHCI_BLOCK_SIZE);
464 sdhci_writew(host, SDHCI_TRNS_READ, SDHCI_TRANSFER_MODE);
467 cmd.resp_type = MMC_RSP_R1;
471 ret = mmc_send_cmd(mmc, &cmd, NULL);
472 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2);
473 if (ret || tuning_loop_counter-- == 0)
475 } while (ctrl & SDHCI_CTRL_EXEC_TUNING);
477 if (ret || tuning_loop_counter < 0 || !(ctrl & SDHCI_CTRL_TUNED_CLK)) {
480 printf("%s: Tuning failed: %d\n", __func__, ret);
482 ctrl &= ~SDHCI_CTRL_TUNED_CLK;
483 ctrl &= ~SDHCI_CTRL_EXEC_TUNING;
484 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2);
487 /* Enable only interrupts served by the SD controller */
488 sdhci_writel(host, SDHCI_INT_DATA_MASK | SDHCI_INT_CMD_MASK, SDHCI_INT_ENABLE);
493 static int rockchip_sdhci_config_dll(struct sdhci_host *host, u32 clock, bool enable)
495 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
496 struct sdhci_data *data = (struct sdhci_data *)dev_get_driver_data(priv->dev);
498 if (data->config_dll)
499 return data->config_dll(host, clock, enable);
504 static int rockchip_sdhci_set_enhanced_strobe(struct sdhci_host *host)
506 struct rockchip_sdhc *priv = container_of(host, struct rockchip_sdhc, host);
507 struct sdhci_data *data = (struct sdhci_data *)dev_get_driver_data(priv->dev);
509 if (data->set_enhanced_strobe)
510 return data->set_enhanced_strobe(host);
515 static struct sdhci_ops rockchip_sdhci_ops = {
516 .set_control_reg = rockchip_sdhci_set_control_reg,
517 .set_ios_post = rockchip_sdhci_set_ios_post,
518 .set_clock = rockchip_sdhci_set_clock,
519 .platform_execute_tuning = rockchip_sdhci_execute_tuning,
520 .config_dll = rockchip_sdhci_config_dll,
521 .set_enhanced_strobe = rockchip_sdhci_set_enhanced_strobe,
524 static int rockchip_sdhci_probe(struct udevice *dev)
526 struct sdhci_data *data = (struct sdhci_data *)dev_get_driver_data(dev);
527 struct mmc_uclass_priv *upriv = dev_get_uclass_priv(dev);
528 struct rockchip_sdhc_plat *plat = dev_get_plat(dev);
529 struct rockchip_sdhc *priv = dev_get_priv(dev);
530 struct mmc_config *cfg = &plat->cfg;
531 struct sdhci_host *host = &priv->host;
535 host->max_clk = cfg->f_max;
536 ret = clk_get_by_index(dev, 0, &clk);
538 ret = clk_set_rate(&clk, host->max_clk);
539 if (IS_ERR_VALUE(ret))
540 printf("%s clk set rate fail!\n", __func__);
542 printf("%s fail to get clk\n", __func__);
545 priv->emmc_clk = clk;
549 ret = data->get_phy(dev);
554 host->ops = &rockchip_sdhci_ops;
555 host->quirks = SDHCI_QUIRK_WAIT_SEND_CMD;
557 host->mmc = &plat->mmc;
558 host->mmc->priv = &priv->host;
559 host->mmc->dev = dev;
560 upriv->mmc = host->mmc;
562 ret = sdhci_setup_cfg(cfg, host, cfg->f_max, EMMC_MIN_FREQ);
566 return sdhci_probe(dev);
569 static int rockchip_sdhci_of_to_plat(struct udevice *dev)
571 struct rockchip_sdhc_plat *plat = dev_get_plat(dev);
572 struct rockchip_sdhc *priv = dev_get_priv(dev);
573 struct mmc_config *cfg = &plat->cfg;
574 struct sdhci_host *host = &priv->host;
577 host->name = dev->name;
578 host->ioaddr = dev_read_addr_ptr(dev);
580 ret = mmc_of_parse(dev, cfg);
587 static int rockchip_sdhci_bind(struct udevice *dev)
589 struct rockchip_sdhc_plat *plat = dev_get_plat(dev);
591 return sdhci_bind(dev, &plat->mmc, &plat->cfg);
594 static const struct sdhci_data rk3399_data = {
595 .get_phy = rk3399_emmc_get_phy,
596 .set_control_reg = rk3399_sdhci_set_control_reg,
597 .set_ios_post = rk3399_sdhci_set_ios_post,
598 .set_enhanced_strobe = rk3399_sdhci_set_enhanced_strobe,
601 static const struct sdhci_data rk3568_data = {
602 .get_phy = rk3568_emmc_get_phy,
603 .set_ios_post = rk3568_sdhci_set_ios_post,
604 .set_clock = rk3568_sdhci_set_clock,
605 .config_dll = rk3568_sdhci_config_dll,
606 .set_enhanced_strobe = rk3568_sdhci_set_enhanced_strobe,
609 static const struct udevice_id sdhci_ids[] = {
611 .compatible = "arasan,sdhci-5.1",
612 .data = (ulong)&rk3399_data,
615 .compatible = "rockchip,rk3568-dwcmshc",
616 .data = (ulong)&rk3568_data,
621 U_BOOT_DRIVER(arasan_sdhci_drv) = {
622 .name = "rockchip_sdhci_5_1",
624 .of_match = sdhci_ids,
625 .of_to_plat = rockchip_sdhci_of_to_plat,
627 .bind = rockchip_sdhci_bind,
628 .probe = rockchip_sdhci_probe,
629 .priv_auto = sizeof(struct rockchip_sdhc),
630 .plat_auto = sizeof(struct rockchip_sdhc_plat),