1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2013 - 2015 Xilinx, Inc.
5 * Xilinx Zynq SD Host Controller Interface
12 #include <linux/delay.h>
13 #include "mmc_private.h"
15 #include <dm/device_compat.h>
16 #include <linux/err.h>
17 #include <linux/libfdt.h>
20 #include <zynqmp_tap_delay.h>
22 #define SDHCI_ARASAN_ITAPDLY_REGISTER 0xF0F8
23 #define SDHCI_ARASAN_OTAPDLY_REGISTER 0xF0FC
24 #define SDHCI_ITAPDLY_CHGWIN 0x200
25 #define SDHCI_ITAPDLY_ENABLE 0x100
26 #define SDHCI_OTAPDLY_ENABLE 0x40
28 #define SDHCI_TUNING_LOOP_COUNT 40
31 struct arasan_sdhci_clk_data {
32 int clk_phase_in[MMC_TIMING_MMC_HS400 + 1];
33 int clk_phase_out[MMC_TIMING_MMC_HS400 + 1];
36 struct arasan_sdhci_plat {
37 struct mmc_config cfg;
41 struct arasan_sdhci_priv {
42 struct sdhci_host *host;
43 struct arasan_sdhci_clk_data clk_data;
49 #if defined(CONFIG_ARCH_ZYNQMP) || defined(CONFIG_ARCH_VERSAL)
50 /* Default settings for ZynqMP Clock Phases */
51 const u32 zynqmp_iclk_phases[] = {0, 63, 63, 0, 63, 0, 0, 183, 54, 0, 0};
52 const u32 zynqmp_oclk_phases[] = {0, 72, 60, 0, 60, 72, 135, 48, 72, 135, 0};
54 /* Default settings for Versal Clock Phases */
55 const u32 versal_iclk_phases[] = {0, 132, 132, 0, 132, 0, 0, 162, 90, 0, 0};
56 const u32 versal_oclk_phases[] = {0, 60, 48, 0, 48, 72, 90, 36, 60, 90, 0};
58 static const u8 mode2timing[] = {
59 [MMC_LEGACY] = MMC_TIMING_LEGACY,
60 [MMC_HS] = MMC_TIMING_MMC_HS,
61 [SD_HS] = MMC_TIMING_SD_HS,
62 [MMC_HS_52] = MMC_TIMING_UHS_SDR50,
63 [MMC_DDR_52] = MMC_TIMING_UHS_DDR50,
64 [UHS_SDR12] = MMC_TIMING_UHS_SDR12,
65 [UHS_SDR25] = MMC_TIMING_UHS_SDR25,
66 [UHS_SDR50] = MMC_TIMING_UHS_SDR50,
67 [UHS_DDR50] = MMC_TIMING_UHS_DDR50,
68 [UHS_SDR104] = MMC_TIMING_UHS_SDR104,
69 [MMC_HS_200] = MMC_TIMING_MMC_HS200,
72 static void arasan_zynqmp_dll_reset(struct sdhci_host *host, u8 deviceid)
75 unsigned long timeout;
77 clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL);
78 clk &= ~(SDHCI_CLOCK_CARD_EN);
79 sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
82 zynqmp_dll_reset(deviceid);
86 while (!((clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL))
87 & SDHCI_CLOCK_INT_STABLE)) {
89 dev_err(mmc_dev(host->mmc),
90 ": Internal clock never stabilised.\n");
97 clk |= SDHCI_CLOCK_CARD_EN;
98 sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL);
101 static int arasan_sdhci_execute_tuning(struct mmc *mmc, u8 opcode)
104 struct mmc_data data;
106 struct sdhci_host *host;
107 struct arasan_sdhci_priv *priv = dev_get_priv(mmc->dev);
108 char tuning_loop_counter = SDHCI_TUNING_LOOP_COUNT;
111 debug("%s\n", __func__);
114 deviceid = priv->deviceid;
116 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2);
117 ctrl |= SDHCI_CTRL_EXEC_TUNING;
118 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2);
122 arasan_zynqmp_dll_reset(host, deviceid);
124 sdhci_writel(host, SDHCI_INT_DATA_AVAIL, SDHCI_INT_ENABLE);
125 sdhci_writel(host, SDHCI_INT_DATA_AVAIL, SDHCI_SIGNAL_ENABLE);
129 cmd.resp_type = MMC_RSP_R1;
134 data.flags = MMC_DATA_READ;
136 if (tuning_loop_counter-- == 0)
139 if (cmd.cmdidx == MMC_CMD_SEND_TUNING_BLOCK_HS200 &&
141 data.blocksize = 128;
143 sdhci_writew(host, SDHCI_MAKE_BLKSZ(SDHCI_DEFAULT_BOUNDARY_ARG,
146 sdhci_writew(host, data.blocks, SDHCI_BLOCK_COUNT);
147 sdhci_writew(host, SDHCI_TRNS_READ, SDHCI_TRANSFER_MODE);
149 mmc_send_cmd(mmc, &cmd, NULL);
150 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2);
152 if (cmd.cmdidx == MMC_CMD_SEND_TUNING_BLOCK)
155 } while (ctrl & SDHCI_CTRL_EXEC_TUNING);
157 if (tuning_loop_counter < 0) {
158 ctrl &= ~SDHCI_CTRL_TUNED_CLK;
159 sdhci_writel(host, ctrl, SDHCI_HOST_CONTROL2);
162 if (!(ctrl & SDHCI_CTRL_TUNED_CLK)) {
163 printf("%s:Tuning failed\n", __func__);
168 arasan_zynqmp_dll_reset(host, deviceid);
170 /* Enable only interrupts served by the SD controller */
171 sdhci_writel(host, SDHCI_INT_DATA_MASK | SDHCI_INT_CMD_MASK,
173 /* Mask all sdhci interrupt sources */
174 sdhci_writel(host, 0x0, SDHCI_SIGNAL_ENABLE);
180 * sdhci_zynqmp_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
182 * Set the SD Output Clock Tap Delays for Output path
184 * @host: Pointer to the sdhci_host structure.
185 * @degrees: The clock phase shift between 0 - 359.
186 * Return: 0 on success and error value on error
188 static int sdhci_zynqmp_sdcardclk_set_phase(struct sdhci_host *host,
191 struct arasan_sdhci_priv *priv = dev_get_priv(host->mmc->dev);
192 struct mmc *mmc = (struct mmc *)host->mmc;
193 u8 tap_delay, tap_max = 0;
195 int timing = mode2timing[mmc->selected_mode];
198 * This is applicable for SDHCI_SPEC_300 and above
199 * ZynqMP does not set phase for <=25MHz clock.
200 * If degrees is zero, no need to do anything.
202 if (SDHCI_GET_VERSION(host) < SDHCI_SPEC_300 ||
203 timing == MMC_TIMING_LEGACY ||
204 timing == MMC_TIMING_UHS_SDR12 || !degrees)
208 case MMC_TIMING_MMC_HS:
209 case MMC_TIMING_SD_HS:
210 case MMC_TIMING_UHS_SDR25:
211 case MMC_TIMING_UHS_DDR50:
212 case MMC_TIMING_MMC_DDR52:
213 /* For 50MHz clock, 30 Taps are available */
216 case MMC_TIMING_UHS_SDR50:
217 /* For 100MHz clock, 15 Taps are available */
220 case MMC_TIMING_UHS_SDR104:
221 case MMC_TIMING_MMC_HS200:
222 /* For 200MHz clock, 8 Taps are available */
228 tap_delay = (degrees * tap_max) / 360;
230 arasan_zynqmp_set_tapdelay(priv->deviceid, 0, tap_delay);
236 * sdhci_zynqmp_sampleclk_set_phase - Set the SD Input Clock Tap Delays
238 * Set the SD Input Clock Tap Delays for Input path
240 * @host: Pointer to the sdhci_host structure.
241 * @degrees: The clock phase shift between 0 - 359.
242 * Return: 0 on success and error value on error
244 static int sdhci_zynqmp_sampleclk_set_phase(struct sdhci_host *host,
247 struct arasan_sdhci_priv *priv = dev_get_priv(host->mmc->dev);
248 struct mmc *mmc = (struct mmc *)host->mmc;
249 u8 tap_delay, tap_max = 0;
251 int timing = mode2timing[mmc->selected_mode];
254 * This is applicable for SDHCI_SPEC_300 and above
255 * ZynqMP does not set phase for <=25MHz clock.
256 * If degrees is zero, no need to do anything.
258 if (SDHCI_GET_VERSION(host) < SDHCI_SPEC_300 ||
259 timing == MMC_TIMING_LEGACY ||
260 timing == MMC_TIMING_UHS_SDR12 || !degrees)
264 case MMC_TIMING_MMC_HS:
265 case MMC_TIMING_SD_HS:
266 case MMC_TIMING_UHS_SDR25:
267 case MMC_TIMING_UHS_DDR50:
268 case MMC_TIMING_MMC_DDR52:
269 /* For 50MHz clock, 120 Taps are available */
272 case MMC_TIMING_UHS_SDR50:
273 /* For 100MHz clock, 60 Taps are available */
276 case MMC_TIMING_UHS_SDR104:
277 case MMC_TIMING_MMC_HS200:
278 /* For 200MHz clock, 30 Taps are available */
284 tap_delay = (degrees * tap_max) / 360;
286 arasan_zynqmp_set_tapdelay(priv->deviceid, tap_delay, 0);
292 * sdhci_versal_sdcardclk_set_phase - Set the SD Output Clock Tap Delays
294 * Set the SD Output Clock Tap Delays for Output path
296 * @host: Pointer to the sdhci_host structure.
297 * @degrees The clock phase shift between 0 - 359.
298 * Return: 0 on success and error value on error
300 static int sdhci_versal_sdcardclk_set_phase(struct sdhci_host *host,
303 struct mmc *mmc = (struct mmc *)host->mmc;
304 u8 tap_delay, tap_max = 0;
306 int timing = mode2timing[mmc->selected_mode];
309 * This is applicable for SDHCI_SPEC_300 and above
310 * Versal does not set phase for <=25MHz clock.
311 * If degrees is zero, no need to do anything.
313 if (SDHCI_GET_VERSION(host) < SDHCI_SPEC_300 ||
314 timing == MMC_TIMING_LEGACY ||
315 timing == MMC_TIMING_UHS_SDR12 || !degrees)
319 case MMC_TIMING_MMC_HS:
320 case MMC_TIMING_SD_HS:
321 case MMC_TIMING_UHS_SDR25:
322 case MMC_TIMING_UHS_DDR50:
323 case MMC_TIMING_MMC_DDR52:
324 /* For 50MHz clock, 30 Taps are available */
327 case MMC_TIMING_UHS_SDR50:
328 /* For 100MHz clock, 15 Taps are available */
331 case MMC_TIMING_UHS_SDR104:
332 case MMC_TIMING_MMC_HS200:
333 /* For 200MHz clock, 8 Taps are available */
339 tap_delay = (degrees * tap_max) / 360;
341 /* Set the Clock Phase */
345 regval = sdhci_readl(host, SDHCI_ARASAN_OTAPDLY_REGISTER);
346 regval |= SDHCI_OTAPDLY_ENABLE;
347 sdhci_writel(host, regval, SDHCI_ARASAN_OTAPDLY_REGISTER);
349 sdhci_writel(host, regval, SDHCI_ARASAN_OTAPDLY_REGISTER);
356 * sdhci_versal_sampleclk_set_phase - Set the SD Input Clock Tap Delays
358 * Set the SD Input Clock Tap Delays for Input path
360 * @host: Pointer to the sdhci_host structure.
361 * @degrees The clock phase shift between 0 - 359.
362 * Return: 0 on success and error value on error
364 static int sdhci_versal_sampleclk_set_phase(struct sdhci_host *host,
367 struct mmc *mmc = (struct mmc *)host->mmc;
368 u8 tap_delay, tap_max = 0;
370 int timing = mode2timing[mmc->selected_mode];
373 * This is applicable for SDHCI_SPEC_300 and above
374 * Versal does not set phase for <=25MHz clock.
375 * If degrees is zero, no need to do anything.
377 if (SDHCI_GET_VERSION(host) < SDHCI_SPEC_300 ||
378 timing == MMC_TIMING_LEGACY ||
379 timing == MMC_TIMING_UHS_SDR12 || !degrees)
383 case MMC_TIMING_MMC_HS:
384 case MMC_TIMING_SD_HS:
385 case MMC_TIMING_UHS_SDR25:
386 case MMC_TIMING_UHS_DDR50:
387 case MMC_TIMING_MMC_DDR52:
388 /* For 50MHz clock, 120 Taps are available */
391 case MMC_TIMING_UHS_SDR50:
392 /* For 100MHz clock, 60 Taps are available */
395 case MMC_TIMING_UHS_SDR104:
396 case MMC_TIMING_MMC_HS200:
397 /* For 200MHz clock, 30 Taps are available */
403 tap_delay = (degrees * tap_max) / 360;
405 /* Set the Clock Phase */
409 regval = sdhci_readl(host, SDHCI_ARASAN_ITAPDLY_REGISTER);
410 regval |= SDHCI_ITAPDLY_CHGWIN;
411 sdhci_writel(host, regval, SDHCI_ARASAN_ITAPDLY_REGISTER);
412 regval |= SDHCI_ITAPDLY_ENABLE;
413 sdhci_writel(host, regval, SDHCI_ARASAN_ITAPDLY_REGISTER);
415 sdhci_writel(host, regval, SDHCI_ARASAN_ITAPDLY_REGISTER);
416 regval &= ~SDHCI_ITAPDLY_CHGWIN;
417 sdhci_writel(host, regval, SDHCI_ARASAN_ITAPDLY_REGISTER);
423 static void arasan_sdhci_set_tapdelay(struct sdhci_host *host)
425 struct arasan_sdhci_priv *priv = dev_get_priv(host->mmc->dev);
426 struct arasan_sdhci_clk_data *clk_data = &priv->clk_data;
427 struct mmc *mmc = (struct mmc *)host->mmc;
428 struct udevice *dev = mmc->dev;
429 u8 timing = mode2timing[mmc->selected_mode];
430 u32 iclk_phase = clk_data->clk_phase_in[timing];
431 u32 oclk_phase = clk_data->clk_phase_out[timing];
433 dev_dbg(dev, "%s, host:%s, mode:%d\n", __func__, host->name, timing);
435 if (IS_ENABLED(CONFIG_ARCH_ZYNQMP) &&
436 device_is_compatible(dev, "xlnx,zynqmp-8.9a")) {
437 sdhci_zynqmp_sampleclk_set_phase(host, iclk_phase);
438 sdhci_zynqmp_sdcardclk_set_phase(host, oclk_phase);
439 } else if (IS_ENABLED(CONFIG_ARCH_VERSAL) &&
440 device_is_compatible(dev, "xlnx,versal-8.9a")) {
441 sdhci_versal_sampleclk_set_phase(host, iclk_phase);
442 sdhci_versal_sdcardclk_set_phase(host, oclk_phase);
446 static void arasan_dt_read_clk_phase(struct udevice *dev, unsigned char timing,
449 struct arasan_sdhci_priv *priv = dev_get_priv(dev);
450 struct arasan_sdhci_clk_data *clk_data = &priv->clk_data;
451 u32 clk_phase[2] = {0};
454 * Read Tap Delay values from DT, if the DT does not contain the
455 * Tap Values then use the pre-defined values
457 if (dev_read_u32_array(dev, prop, &clk_phase[0], 2)) {
458 dev_dbg(dev, "Using predefined clock phase for %s = %d %d\n",
459 prop, clk_data->clk_phase_in[timing],
460 clk_data->clk_phase_out[timing]);
464 /* The values read are Input and Output Clock Delays in order */
465 clk_data->clk_phase_in[timing] = clk_phase[0];
466 clk_data->clk_phase_out[timing] = clk_phase[1];
470 * arasan_dt_parse_clk_phases - Read Tap Delay values from DT
472 * Called at initialization to parse the values of Tap Delays.
474 * @dev: Pointer to our struct udevice.
476 static void arasan_dt_parse_clk_phases(struct udevice *dev)
478 struct arasan_sdhci_priv *priv = dev_get_priv(dev);
479 struct arasan_sdhci_clk_data *clk_data = &priv->clk_data;
482 if (IS_ENABLED(CONFIG_ARCH_ZYNQMP) &&
483 device_is_compatible(dev, "xlnx,zynqmp-8.9a")) {
484 for (i = 0; i <= MMC_TIMING_MMC_HS400; i++) {
485 clk_data->clk_phase_in[i] = zynqmp_iclk_phases[i];
486 clk_data->clk_phase_out[i] = zynqmp_oclk_phases[i];
489 if (priv->bank == MMC_BANK2) {
490 clk_data->clk_phase_out[MMC_TIMING_UHS_SDR104] = 90;
491 clk_data->clk_phase_out[MMC_TIMING_MMC_HS200] = 90;
495 if (IS_ENABLED(CONFIG_ARCH_VERSAL) &&
496 device_is_compatible(dev, "xlnx,versal-8.9a")) {
497 for (i = 0; i <= MMC_TIMING_MMC_HS400; i++) {
498 clk_data->clk_phase_in[i] = versal_iclk_phases[i];
499 clk_data->clk_phase_out[i] = versal_oclk_phases[i];
503 arasan_dt_read_clk_phase(dev, MMC_TIMING_LEGACY,
505 arasan_dt_read_clk_phase(dev, MMC_TIMING_MMC_HS,
507 arasan_dt_read_clk_phase(dev, MMC_TIMING_SD_HS,
509 arasan_dt_read_clk_phase(dev, MMC_TIMING_UHS_SDR12,
510 "clk-phase-uhs-sdr12");
511 arasan_dt_read_clk_phase(dev, MMC_TIMING_UHS_SDR25,
512 "clk-phase-uhs-sdr25");
513 arasan_dt_read_clk_phase(dev, MMC_TIMING_UHS_SDR50,
514 "clk-phase-uhs-sdr50");
515 arasan_dt_read_clk_phase(dev, MMC_TIMING_UHS_SDR104,
516 "clk-phase-uhs-sdr104");
517 arasan_dt_read_clk_phase(dev, MMC_TIMING_UHS_DDR50,
518 "clk-phase-uhs-ddr50");
519 arasan_dt_read_clk_phase(dev, MMC_TIMING_MMC_DDR52,
520 "clk-phase-mmc-ddr52");
521 arasan_dt_read_clk_phase(dev, MMC_TIMING_MMC_HS200,
522 "clk-phase-mmc-hs200");
523 arasan_dt_read_clk_phase(dev, MMC_TIMING_MMC_HS400,
524 "clk-phase-mmc-hs400");
527 static void arasan_sdhci_set_control_reg(struct sdhci_host *host)
529 struct mmc *mmc = (struct mmc *)host->mmc;
535 if (mmc->signal_voltage == MMC_SIGNAL_VOLTAGE_180) {
536 reg = sdhci_readw(host, SDHCI_HOST_CONTROL2);
537 reg |= SDHCI_CTRL_VDD_180;
538 sdhci_writew(host, reg, SDHCI_HOST_CONTROL2);
541 if (mmc->selected_mode > SD_HS &&
542 mmc->selected_mode <= MMC_HS_200)
543 sdhci_set_uhs_timing(host);
546 const struct sdhci_ops arasan_ops = {
547 .platform_execute_tuning = &arasan_sdhci_execute_tuning,
548 .set_delay = &arasan_sdhci_set_tapdelay,
549 .set_control_reg = &arasan_sdhci_set_control_reg,
553 static int arasan_sdhci_probe(struct udevice *dev)
555 struct arasan_sdhci_plat *plat = dev_get_plat(dev);
556 struct mmc_uclass_priv *upriv = dev_get_uclass_priv(dev);
557 struct arasan_sdhci_priv *priv = dev_get_priv(dev);
558 struct sdhci_host *host;
565 ret = clk_get_by_index(dev, 0, &clk);
567 dev_err(dev, "failed to get clock\n");
571 clock = clk_get_rate(&clk);
572 if (IS_ERR_VALUE(clock)) {
573 dev_err(dev, "failed to get rate\n");
577 debug("%s: CLK %ld\n", __func__, clock);
579 ret = clk_enable(&clk);
581 dev_err(dev, "failed to enable clock\n");
585 host->quirks = SDHCI_QUIRK_WAIT_SEND_CMD |
586 SDHCI_QUIRK_BROKEN_R1B;
588 #ifdef CONFIG_ZYNQ_HISPD_BROKEN
589 host->quirks |= SDHCI_QUIRK_BROKEN_HISPD_MODE;
593 host->quirks |= SDHCI_QUIRK_NO_1_8_V;
595 plat->cfg.f_max = CONFIG_ZYNQ_SDHCI_MAX_FREQ;
597 ret = mmc_of_parse(dev, &plat->cfg);
601 host->max_clk = clock;
603 host->mmc = &plat->mmc;
604 host->mmc->dev = dev;
605 host->mmc->priv = host;
607 ret = sdhci_setup_cfg(&plat->cfg, host, plat->cfg.f_max,
608 CONFIG_ZYNQ_SDHCI_MIN_FREQ);
611 upriv->mmc = host->mmc;
613 return sdhci_probe(dev);
616 static int arasan_sdhci_of_to_plat(struct udevice *dev)
618 struct arasan_sdhci_priv *priv = dev_get_priv(dev);
620 priv->host = calloc(1, sizeof(struct sdhci_host));
624 priv->host->name = dev->name;
626 #if defined(CONFIG_ARCH_ZYNQMP) || defined(CONFIG_ARCH_VERSAL)
627 priv->host->ops = &arasan_ops;
628 arasan_dt_parse_clk_phases(dev);
631 priv->host->ioaddr = (void *)dev_read_addr(dev);
632 if (IS_ERR(priv->host->ioaddr))
633 return PTR_ERR(priv->host->ioaddr);
635 priv->deviceid = dev_read_u32_default(dev, "xlnx,device_id", -1);
636 priv->bank = dev_read_u32_default(dev, "xlnx,mio-bank", 0);
637 priv->no_1p8 = dev_read_bool(dev, "no-1-8-v");
642 static int arasan_sdhci_bind(struct udevice *dev)
644 struct arasan_sdhci_plat *plat = dev_get_plat(dev);
646 return sdhci_bind(dev, &plat->mmc, &plat->cfg);
649 static const struct udevice_id arasan_sdhci_ids[] = {
650 { .compatible = "arasan,sdhci-8.9a" },
654 U_BOOT_DRIVER(arasan_sdhci_drv) = {
655 .name = "arasan_sdhci",
657 .of_match = arasan_sdhci_ids,
658 .of_to_plat = arasan_sdhci_of_to_plat,
660 .bind = arasan_sdhci_bind,
661 .probe = arasan_sdhci_probe,
662 .priv_auto = sizeof(struct arasan_sdhci_priv),
663 .plat_auto = sizeof(struct arasan_sdhci_plat),