1 // SPDX-License-Identifier: GPL-2.0
3 * sdhci_am654.c - SDHCI driver for TI's AM654 SOCs
5 * Copyright (C) 2018 Texas Instruments Incorporated - http://www.ti.com
10 #include <linux/module.h>
11 #include <linux/pm_runtime.h>
12 #include <linux/property.h>
13 #include <linux/regmap.h>
16 #include "sdhci-pltfm.h"
18 /* CTL_CFG Registers */
19 #define CTL_CFG_2 0x14
21 #define SLOTTYPE_MASK GENMASK(31, 30)
22 #define SLOTTYPE_EMBEDDED BIT(30)
25 #define PHY_CTRL1 0x100
26 #define PHY_CTRL2 0x104
27 #define PHY_CTRL3 0x108
28 #define PHY_CTRL4 0x10C
29 #define PHY_CTRL5 0x110
30 #define PHY_CTRL6 0x114
31 #define PHY_STAT1 0x130
32 #define PHY_STAT2 0x134
34 #define IOMUX_ENABLE_SHIFT 31
35 #define IOMUX_ENABLE_MASK BIT(IOMUX_ENABLE_SHIFT)
36 #define OTAPDLYENA_SHIFT 20
37 #define OTAPDLYENA_MASK BIT(OTAPDLYENA_SHIFT)
38 #define OTAPDLYSEL_SHIFT 12
39 #define OTAPDLYSEL_MASK GENMASK(15, 12)
40 #define STRBSEL_SHIFT 24
41 #define STRBSEL_4BIT_MASK GENMASK(27, 24)
42 #define STRBSEL_8BIT_MASK GENMASK(31, 24)
44 #define SEL50_MASK BIT(SEL50_SHIFT)
45 #define SEL100_SHIFT 9
46 #define SEL100_MASK BIT(SEL100_SHIFT)
47 #define FREQSEL_SHIFT 8
48 #define FREQSEL_MASK GENMASK(10, 8)
49 #define DLL_TRIM_ICP_SHIFT 4
50 #define DLL_TRIM_ICP_MASK GENMASK(7, 4)
51 #define DR_TY_SHIFT 20
52 #define DR_TY_MASK GENMASK(22, 20)
54 #define ENDLL_MASK BIT(ENDLL_SHIFT)
55 #define DLLRDY_SHIFT 0
56 #define DLLRDY_MASK BIT(DLLRDY_SHIFT)
58 #define PDB_MASK BIT(PDB_SHIFT)
59 #define CALDONE_SHIFT 1
60 #define CALDONE_MASK BIT(CALDONE_SHIFT)
61 #define RETRIM_SHIFT 17
62 #define RETRIM_MASK BIT(RETRIM_SHIFT)
64 #define DRIVER_STRENGTH_50_OHM 0x0
65 #define DRIVER_STRENGTH_33_OHM 0x1
66 #define DRIVER_STRENGTH_66_OHM 0x2
67 #define DRIVER_STRENGTH_100_OHM 0x3
68 #define DRIVER_STRENGTH_40_OHM 0x4
70 #define CLOCK_TOO_SLOW_HZ 400000
72 /* Command Queue Host Controller Interface Base address */
73 #define SDHCI_AM654_CQE_BASE_ADDR 0x200
75 static struct regmap_config sdhci_am654_regmap_config = {
82 struct sdhci_am654_data {
93 struct sdhci_am654_driver_data {
94 const struct sdhci_pltfm_data *pdata;
96 #define IOMUX_PRESENT (1 << 0)
97 #define FREQSEL_2_BIT (1 << 1)
98 #define STRBSEL_4_BIT (1 << 2)
99 #define DLL_PRESENT (1 << 3)
107 static const struct timing_data td[] = {
108 [MMC_TIMING_LEGACY] = {"ti,otap-del-sel-legacy", 0},
109 [MMC_TIMING_MMC_HS] = {"ti,otap-del-sel-mmc-hs", MMC_CAP_MMC_HIGHSPEED},
110 [MMC_TIMING_SD_HS] = {"ti,otap-del-sel-sd-hs", MMC_CAP_SD_HIGHSPEED},
111 [MMC_TIMING_UHS_SDR12] = {"ti,otap-del-sel-sdr12", MMC_CAP_UHS_SDR12},
112 [MMC_TIMING_UHS_SDR25] = {"ti,otap-del-sel-sdr25", MMC_CAP_UHS_SDR25},
113 [MMC_TIMING_UHS_SDR50] = {"ti,otap-del-sel-sdr50", MMC_CAP_UHS_SDR50},
114 [MMC_TIMING_UHS_SDR104] = {"ti,otap-del-sel-sdr104",
116 [MMC_TIMING_UHS_DDR50] = {"ti,otap-del-sel-ddr50", MMC_CAP_UHS_DDR50},
117 [MMC_TIMING_MMC_DDR52] = {"ti,otap-del-sel-ddr52", MMC_CAP_DDR},
118 [MMC_TIMING_MMC_HS200] = {"ti,otap-del-sel-hs200", MMC_CAP2_HS200},
119 [MMC_TIMING_MMC_HS400] = {"ti,otap-del-sel-hs400", MMC_CAP2_HS400},
122 static void sdhci_am654_setup_dll(struct sdhci_host *host, unsigned int clock)
124 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
125 struct sdhci_am654_data *sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
126 int sel50, sel100, freqsel;
130 if (sdhci_am654->flags & FREQSEL_2_BIT) {
145 /* Configure PHY DLL frequency */
146 mask = SEL50_MASK | SEL100_MASK;
147 val = (sel50 << SEL50_SHIFT) | (sel100 << SEL100_SHIFT);
148 regmap_update_bits(sdhci_am654->base, PHY_CTRL5, mask, val);
159 regmap_update_bits(sdhci_am654->base, PHY_CTRL5, FREQSEL_MASK,
160 freqsel << FREQSEL_SHIFT);
162 /* Configure DLL TRIM */
163 mask = DLL_TRIM_ICP_MASK;
164 val = sdhci_am654->trm_icp << DLL_TRIM_ICP_SHIFT;
166 /* Configure DLL driver strength */
168 val |= sdhci_am654->drv_strength << DR_TY_SHIFT;
169 regmap_update_bits(sdhci_am654->base, PHY_CTRL1, mask, val);
172 regmap_update_bits(sdhci_am654->base, PHY_CTRL1, ENDLL_MASK,
175 * Poll for DLL ready. Use a one second timeout.
176 * Works in all experiments done so far
178 ret = regmap_read_poll_timeout(sdhci_am654->base, PHY_STAT1, val,
179 val & DLLRDY_MASK, 1000, 1000000);
181 dev_err(mmc_dev(host->mmc), "DLL failed to relock\n");
185 sdhci_am654->dll_on = true;
188 static void sdhci_am654_set_clock(struct sdhci_host *host, unsigned int clock)
190 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
191 struct sdhci_am654_data *sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
192 unsigned char timing = host->mmc->ios.timing;
197 if (sdhci_am654->dll_on) {
198 regmap_update_bits(sdhci_am654->base, PHY_CTRL1, ENDLL_MASK, 0);
200 sdhci_am654->dll_on = false;
203 sdhci_set_clock(host, clock);
205 if (clock > CLOCK_TOO_SLOW_HZ) {
206 /* Setup DLL Output TAP delay */
207 if (sdhci_am654->legacy_otapdly)
208 otap_del_sel = sdhci_am654->otap_del_sel[0];
210 otap_del_sel = sdhci_am654->otap_del_sel[timing];
212 otap_del_ena = (timing > MMC_TIMING_UHS_SDR25) ? 1 : 0;
214 mask = OTAPDLYENA_MASK | OTAPDLYSEL_MASK;
215 val = (otap_del_ena << OTAPDLYENA_SHIFT) |
216 (otap_del_sel << OTAPDLYSEL_SHIFT);
218 /* Write to STRBSEL for HS400 speed mode */
219 if (timing == MMC_TIMING_MMC_HS400) {
220 if (sdhci_am654->flags & STRBSEL_4_BIT)
221 mask |= STRBSEL_4BIT_MASK;
223 mask |= STRBSEL_8BIT_MASK;
225 val |= sdhci_am654->strb_sel << STRBSEL_SHIFT;
228 regmap_update_bits(sdhci_am654->base, PHY_CTRL4, mask, val);
230 if (timing > MMC_TIMING_UHS_SDR25)
231 sdhci_am654_setup_dll(host, clock);
235 static void sdhci_j721e_4bit_set_clock(struct sdhci_host *host,
238 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
239 struct sdhci_am654_data *sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
240 unsigned char timing = host->mmc->ios.timing;
244 /* Setup DLL Output TAP delay */
245 if (sdhci_am654->legacy_otapdly)
246 otap_del_sel = sdhci_am654->otap_del_sel[0];
248 otap_del_sel = sdhci_am654->otap_del_sel[timing];
250 mask = OTAPDLYENA_MASK | OTAPDLYSEL_MASK;
251 val = (0x1 << OTAPDLYENA_SHIFT) |
252 (otap_del_sel << OTAPDLYSEL_SHIFT);
253 regmap_update_bits(sdhci_am654->base, PHY_CTRL4, mask, val);
255 sdhci_set_clock(host, clock);
258 static void sdhci_am654_write_b(struct sdhci_host *host, u8 val, int reg)
260 unsigned char timing = host->mmc->ios.timing;
262 if (reg == SDHCI_HOST_CONTROL) {
265 * According to the data manual, HISPD bit
266 * should not be set in these speed modes.
268 case MMC_TIMING_SD_HS:
269 case MMC_TIMING_MMC_HS:
270 case MMC_TIMING_UHS_SDR12:
271 case MMC_TIMING_UHS_SDR25:
272 val &= ~SDHCI_CTRL_HISPD;
276 writeb(val, host->ioaddr + reg);
279 static int sdhci_am654_execute_tuning(struct mmc_host *mmc, u32 opcode)
281 struct sdhci_host *host = mmc_priv(mmc);
282 int err = sdhci_execute_tuning(mmc, opcode);
287 * Tuning data remains in the buffer after tuning.
288 * Do a command and data reset to get rid of it
290 sdhci_reset(host, SDHCI_RESET_CMD | SDHCI_RESET_DATA);
295 static u32 sdhci_am654_cqhci_irq(struct sdhci_host *host, u32 intmask)
300 if (!sdhci_cqe_irq(host, intmask, &cmd_error, &data_error))
303 cqhci_irq(host->mmc, intmask, cmd_error, data_error);
308 static struct sdhci_ops sdhci_am654_ops = {
309 .get_max_clock = sdhci_pltfm_clk_get_max_clock,
310 .get_timeout_clock = sdhci_pltfm_clk_get_max_clock,
311 .set_uhs_signaling = sdhci_set_uhs_signaling,
312 .set_bus_width = sdhci_set_bus_width,
313 .set_power = sdhci_set_power_and_bus_voltage,
314 .set_clock = sdhci_am654_set_clock,
315 .write_b = sdhci_am654_write_b,
316 .irq = sdhci_am654_cqhci_irq,
317 .reset = sdhci_reset,
320 static const struct sdhci_pltfm_data sdhci_am654_pdata = {
321 .ops = &sdhci_am654_ops,
322 .quirks = SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12,
323 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN,
326 static const struct sdhci_am654_driver_data sdhci_am654_drvdata = {
327 .pdata = &sdhci_am654_pdata,
328 .flags = IOMUX_PRESENT | FREQSEL_2_BIT | STRBSEL_4_BIT | DLL_PRESENT,
331 static struct sdhci_ops sdhci_j721e_8bit_ops = {
332 .get_max_clock = sdhci_pltfm_clk_get_max_clock,
333 .get_timeout_clock = sdhci_pltfm_clk_get_max_clock,
334 .set_uhs_signaling = sdhci_set_uhs_signaling,
335 .set_bus_width = sdhci_set_bus_width,
336 .set_power = sdhci_set_power_and_bus_voltage,
337 .set_clock = sdhci_am654_set_clock,
338 .write_b = sdhci_am654_write_b,
339 .irq = sdhci_am654_cqhci_irq,
340 .reset = sdhci_reset,
343 static const struct sdhci_pltfm_data sdhci_j721e_8bit_pdata = {
344 .ops = &sdhci_j721e_8bit_ops,
345 .quirks = SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12,
346 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN,
349 static const struct sdhci_am654_driver_data sdhci_j721e_8bit_drvdata = {
350 .pdata = &sdhci_j721e_8bit_pdata,
351 .flags = DLL_PRESENT,
354 static struct sdhci_ops sdhci_j721e_4bit_ops = {
355 .get_max_clock = sdhci_pltfm_clk_get_max_clock,
356 .get_timeout_clock = sdhci_pltfm_clk_get_max_clock,
357 .set_uhs_signaling = sdhci_set_uhs_signaling,
358 .set_bus_width = sdhci_set_bus_width,
359 .set_power = sdhci_set_power_and_bus_voltage,
360 .set_clock = sdhci_j721e_4bit_set_clock,
361 .write_b = sdhci_am654_write_b,
362 .irq = sdhci_am654_cqhci_irq,
363 .reset = sdhci_reset,
366 static const struct sdhci_pltfm_data sdhci_j721e_4bit_pdata = {
367 .ops = &sdhci_j721e_4bit_ops,
368 .quirks = SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12,
369 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN,
372 static const struct sdhci_am654_driver_data sdhci_j721e_4bit_drvdata = {
373 .pdata = &sdhci_j721e_4bit_pdata,
374 .flags = IOMUX_PRESENT,
377 static void sdhci_am654_dumpregs(struct mmc_host *mmc)
379 sdhci_dumpregs(mmc_priv(mmc));
382 static const struct cqhci_host_ops sdhci_am654_cqhci_ops = {
383 .enable = sdhci_cqe_enable,
384 .disable = sdhci_cqe_disable,
385 .dumpregs = sdhci_am654_dumpregs,
388 static int sdhci_am654_cqe_add_host(struct sdhci_host *host)
390 struct cqhci_host *cq_host;
393 cq_host = devm_kzalloc(host->mmc->parent, sizeof(struct cqhci_host),
398 cq_host->mmio = host->ioaddr + SDHCI_AM654_CQE_BASE_ADDR;
399 cq_host->quirks |= CQHCI_QUIRK_SHORT_TXFR_DESC_SZ;
400 cq_host->caps |= CQHCI_TASK_DESC_SZ_128;
401 cq_host->ops = &sdhci_am654_cqhci_ops;
403 host->mmc->caps2 |= MMC_CAP2_CQE;
405 ret = cqhci_init(cq_host, host->mmc, 1);
410 static int sdhci_am654_get_otap_delay(struct sdhci_host *host,
411 struct sdhci_am654_data *sdhci_am654)
413 struct device *dev = mmc_dev(host->mmc);
417 ret = device_property_read_u32(dev, td[MMC_TIMING_LEGACY].binding,
418 &sdhci_am654->otap_del_sel[MMC_TIMING_LEGACY]);
421 * ti,otap-del-sel-legacy is mandatory, look for old binding
424 ret = device_property_read_u32(dev, "ti,otap-del-sel",
425 &sdhci_am654->otap_del_sel[0]);
427 dev_err(dev, "Couldn't find otap-del-sel\n");
432 dev_info(dev, "Using legacy binding ti,otap-del-sel\n");
433 sdhci_am654->legacy_otapdly = true;
438 for (i = MMC_TIMING_MMC_HS; i <= MMC_TIMING_MMC_HS400; i++) {
440 ret = device_property_read_u32(dev, td[i].binding,
441 &sdhci_am654->otap_del_sel[i]);
443 dev_dbg(dev, "Couldn't find %s\n",
446 * Remove the corresponding capability
447 * if an otap-del-sel value is not found
449 if (i <= MMC_TIMING_MMC_DDR52)
450 host->mmc->caps &= ~td[i].capability;
452 host->mmc->caps2 &= ~td[i].capability;
459 static int sdhci_am654_init(struct sdhci_host *host)
461 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
462 struct sdhci_am654_data *sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
468 /* Reset OTAP to default value */
469 mask = OTAPDLYENA_MASK | OTAPDLYSEL_MASK;
470 regmap_update_bits(sdhci_am654->base, PHY_CTRL4, mask, 0x0);
472 if (sdhci_am654->flags & DLL_PRESENT) {
473 regmap_read(sdhci_am654->base, PHY_STAT1, &val);
474 if (~val & CALDONE_MASK) {
475 /* Calibrate IO lines */
476 regmap_update_bits(sdhci_am654->base, PHY_CTRL1,
478 ret = regmap_read_poll_timeout(sdhci_am654->base,
487 /* Enable pins by setting IO mux to 0 */
488 if (sdhci_am654->flags & IOMUX_PRESENT)
489 regmap_update_bits(sdhci_am654->base, PHY_CTRL1,
490 IOMUX_ENABLE_MASK, 0);
492 /* Set slot type based on SD or eMMC */
493 if (host->mmc->caps & MMC_CAP_NONREMOVABLE)
494 ctl_cfg_2 = SLOTTYPE_EMBEDDED;
496 regmap_update_bits(sdhci_am654->base, CTL_CFG_2, SLOTTYPE_MASK,
499 ret = sdhci_setup_host(host);
503 ret = sdhci_am654_cqe_add_host(host);
505 goto err_cleanup_host;
507 ret = sdhci_am654_get_otap_delay(host, sdhci_am654);
509 goto err_cleanup_host;
511 ret = __sdhci_add_host(host);
513 goto err_cleanup_host;
518 sdhci_cleanup_host(host);
522 static int sdhci_am654_get_of_property(struct platform_device *pdev,
523 struct sdhci_am654_data *sdhci_am654)
525 struct device *dev = &pdev->dev;
529 if (sdhci_am654->flags & DLL_PRESENT) {
530 ret = device_property_read_u32(dev, "ti,trm-icp",
531 &sdhci_am654->trm_icp);
535 ret = device_property_read_u32(dev, "ti,driver-strength-ohm",
540 switch (drv_strength) {
542 sdhci_am654->drv_strength = DRIVER_STRENGTH_50_OHM;
545 sdhci_am654->drv_strength = DRIVER_STRENGTH_33_OHM;
548 sdhci_am654->drv_strength = DRIVER_STRENGTH_66_OHM;
551 sdhci_am654->drv_strength = DRIVER_STRENGTH_100_OHM;
554 sdhci_am654->drv_strength = DRIVER_STRENGTH_40_OHM;
557 dev_err(dev, "Invalid driver strength\n");
562 device_property_read_u32(dev, "ti,strobe-sel", &sdhci_am654->strb_sel);
564 sdhci_get_of_property(pdev);
569 static const struct of_device_id sdhci_am654_of_match[] = {
571 .compatible = "ti,am654-sdhci-5.1",
572 .data = &sdhci_am654_drvdata,
575 .compatible = "ti,j721e-sdhci-8bit",
576 .data = &sdhci_j721e_8bit_drvdata,
579 .compatible = "ti,j721e-sdhci-4bit",
580 .data = &sdhci_j721e_4bit_drvdata,
585 static int sdhci_am654_probe(struct platform_device *pdev)
587 const struct sdhci_am654_driver_data *drvdata;
588 struct sdhci_pltfm_host *pltfm_host;
589 struct sdhci_am654_data *sdhci_am654;
590 const struct of_device_id *match;
591 struct sdhci_host *host;
593 struct device *dev = &pdev->dev;
597 match = of_match_node(sdhci_am654_of_match, pdev->dev.of_node);
598 drvdata = match->data;
599 host = sdhci_pltfm_init(pdev, drvdata->pdata, sizeof(*sdhci_am654));
601 return PTR_ERR(host);
603 pltfm_host = sdhci_priv(host);
604 sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
605 sdhci_am654->flags = drvdata->flags;
607 clk_xin = devm_clk_get(dev, "clk_xin");
608 if (IS_ERR(clk_xin)) {
609 dev_err(dev, "clk_xin clock not found.\n");
610 ret = PTR_ERR(clk_xin);
614 pltfm_host->clk = clk_xin;
616 /* Clocks are enabled using pm_runtime */
617 pm_runtime_enable(dev);
618 ret = pm_runtime_get_sync(dev);
620 pm_runtime_put_noidle(dev);
621 goto pm_runtime_disable;
624 base = devm_platform_ioremap_resource(pdev, 1);
630 sdhci_am654->base = devm_regmap_init_mmio(dev, base,
631 &sdhci_am654_regmap_config);
632 if (IS_ERR(sdhci_am654->base)) {
633 dev_err(dev, "Failed to initialize regmap\n");
634 ret = PTR_ERR(sdhci_am654->base);
638 ret = sdhci_am654_get_of_property(pdev, sdhci_am654);
642 ret = mmc_of_parse(host->mmc);
644 dev_err(dev, "parsing dt failed (%d)\n", ret);
648 host->mmc_host_ops.execute_tuning = sdhci_am654_execute_tuning;
650 ret = sdhci_am654_init(host);
657 pm_runtime_put_sync(dev);
659 pm_runtime_disable(dev);
661 sdhci_pltfm_free(pdev);
665 static int sdhci_am654_remove(struct platform_device *pdev)
667 struct sdhci_host *host = platform_get_drvdata(pdev);
670 sdhci_remove_host(host, true);
671 ret = pm_runtime_put_sync(&pdev->dev);
675 pm_runtime_disable(&pdev->dev);
676 sdhci_pltfm_free(pdev);
681 static struct platform_driver sdhci_am654_driver = {
683 .name = "sdhci-am654",
684 .of_match_table = sdhci_am654_of_match,
686 .probe = sdhci_am654_probe,
687 .remove = sdhci_am654_remove,
690 module_platform_driver(sdhci_am654_driver);
692 MODULE_DESCRIPTION("Driver for SDHCI Controller on TI's AM654 devices");
693 MODULE_AUTHOR("Faiz Abbas <faiz_abbas@ti.com>");
694 MODULE_LICENSE("GPL");