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
9 #include <linux/module.h>
10 #include <linux/pm_runtime.h>
11 #include <linux/property.h>
12 #include <linux/regmap.h>
14 #include "sdhci-pltfm.h"
16 /* CTL_CFG Registers */
17 #define CTL_CFG_2 0x14
19 #define SLOTTYPE_MASK GENMASK(31, 30)
20 #define SLOTTYPE_EMBEDDED BIT(30)
23 #define PHY_CTRL1 0x100
24 #define PHY_CTRL2 0x104
25 #define PHY_CTRL3 0x108
26 #define PHY_CTRL4 0x10C
27 #define PHY_CTRL5 0x110
28 #define PHY_CTRL6 0x114
29 #define PHY_STAT1 0x130
30 #define PHY_STAT2 0x134
32 #define IOMUX_ENABLE_SHIFT 31
33 #define IOMUX_ENABLE_MASK BIT(IOMUX_ENABLE_SHIFT)
34 #define OTAPDLYENA_SHIFT 20
35 #define OTAPDLYENA_MASK BIT(OTAPDLYENA_SHIFT)
36 #define OTAPDLYSEL_SHIFT 12
37 #define OTAPDLYSEL_MASK GENMASK(15, 12)
38 #define STRBSEL_SHIFT 24
39 #define STRBSEL_MASK GENMASK(27, 24)
41 #define SEL50_MASK BIT(SEL50_SHIFT)
42 #define SEL100_SHIFT 9
43 #define SEL100_MASK BIT(SEL100_SHIFT)
44 #define DLL_TRIM_ICP_SHIFT 4
45 #define DLL_TRIM_ICP_MASK GENMASK(7, 4)
46 #define DR_TY_SHIFT 20
47 #define DR_TY_MASK GENMASK(22, 20)
49 #define ENDLL_MASK BIT(ENDLL_SHIFT)
50 #define DLLRDY_SHIFT 0
51 #define DLLRDY_MASK BIT(DLLRDY_SHIFT)
53 #define PDB_MASK BIT(PDB_SHIFT)
54 #define CALDONE_SHIFT 1
55 #define CALDONE_MASK BIT(CALDONE_SHIFT)
56 #define RETRIM_SHIFT 17
57 #define RETRIM_MASK BIT(RETRIM_SHIFT)
59 #define DRIVER_STRENGTH_50_OHM 0x0
60 #define DRIVER_STRENGTH_33_OHM 0x1
61 #define DRIVER_STRENGTH_66_OHM 0x2
62 #define DRIVER_STRENGTH_100_OHM 0x3
63 #define DRIVER_STRENGTH_40_OHM 0x4
65 #define CLOCK_TOO_SLOW_HZ 400000
67 static struct regmap_config sdhci_am654_regmap_config = {
74 struct sdhci_am654_data {
82 static void sdhci_am654_set_clock(struct sdhci_host *host, unsigned int clock)
84 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
85 struct sdhci_am654_data *sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
90 if (sdhci_am654->dll_on) {
91 regmap_update_bits(sdhci_am654->base, PHY_CTRL1,
94 sdhci_am654->dll_on = false;
97 sdhci_set_clock(host, clock);
99 if (clock > CLOCK_TOO_SLOW_HZ) {
100 /* Setup DLL Output TAP delay */
101 mask = OTAPDLYENA_MASK | OTAPDLYSEL_MASK;
102 val = (1 << OTAPDLYENA_SHIFT) |
103 (sdhci_am654->otap_del_sel << OTAPDLYSEL_SHIFT);
104 regmap_update_bits(sdhci_am654->base, PHY_CTRL4,
120 /* Configure PHY DLL frequency */
121 mask = SEL50_MASK | SEL100_MASK;
122 val = (sel50 << SEL50_SHIFT) | (sel100 << SEL100_SHIFT);
123 regmap_update_bits(sdhci_am654->base, PHY_CTRL5,
125 /* Configure DLL TRIM */
126 mask = DLL_TRIM_ICP_MASK;
127 val = sdhci_am654->trm_icp << DLL_TRIM_ICP_SHIFT;
129 /* Configure DLL driver strength */
131 val |= sdhci_am654->drv_strength << DR_TY_SHIFT;
132 regmap_update_bits(sdhci_am654->base, PHY_CTRL1,
135 regmap_update_bits(sdhci_am654->base, PHY_CTRL1,
136 ENDLL_MASK, 0x1 << ENDLL_SHIFT);
138 * Poll for DLL ready. Use a one second timeout.
139 * Works in all experiments done so far
141 ret = regmap_read_poll_timeout(sdhci_am654->base,
146 sdhci_am654->dll_on = true;
150 static void sdhci_am654_set_power(struct sdhci_host *host, unsigned char mode,
153 if (!IS_ERR(host->mmc->supply.vmmc)) {
154 struct mmc_host *mmc = host->mmc;
156 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd);
158 sdhci_set_power_noreg(host, mode, vdd);
161 static void sdhci_am654_write_b(struct sdhci_host *host, u8 val, int reg)
163 unsigned char timing = host->mmc->ios.timing;
165 if (reg == SDHCI_HOST_CONTROL) {
168 * According to the data manual, HISPD bit
169 * should not be set in these speed modes.
171 case MMC_TIMING_SD_HS:
172 case MMC_TIMING_MMC_HS:
173 case MMC_TIMING_UHS_SDR12:
174 case MMC_TIMING_UHS_SDR25:
175 val &= ~SDHCI_CTRL_HISPD;
179 writeb(val, host->ioaddr + reg);
182 static struct sdhci_ops sdhci_am654_ops = {
183 .get_max_clock = sdhci_pltfm_clk_get_max_clock,
184 .get_timeout_clock = sdhci_pltfm_clk_get_max_clock,
185 .set_uhs_signaling = sdhci_set_uhs_signaling,
186 .set_bus_width = sdhci_set_bus_width,
187 .set_power = sdhci_am654_set_power,
188 .set_clock = sdhci_am654_set_clock,
189 .write_b = sdhci_am654_write_b,
190 .reset = sdhci_reset,
193 static const struct sdhci_pltfm_data sdhci_am654_pdata = {
194 .ops = &sdhci_am654_ops,
195 .quirks = SDHCI_QUIRK_INVERTED_WRITE_PROTECT |
196 SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12,
197 .quirks2 = SDHCI_QUIRK2_PRESET_VALUE_BROKEN,
200 static int sdhci_am654_init(struct sdhci_host *host)
202 struct sdhci_pltfm_host *pltfm_host = sdhci_priv(host);
203 struct sdhci_am654_data *sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
209 /* Reset OTAP to default value */
210 mask = OTAPDLYENA_MASK | OTAPDLYSEL_MASK;
211 regmap_update_bits(sdhci_am654->base, PHY_CTRL4,
214 regmap_read(sdhci_am654->base, PHY_STAT1, &val);
215 if (~val & CALDONE_MASK) {
216 /* Calibrate IO lines */
217 regmap_update_bits(sdhci_am654->base, PHY_CTRL1,
219 ret = regmap_read_poll_timeout(sdhci_am654->base, PHY_STAT1,
220 val, val & CALDONE_MASK, 1, 20);
225 /* Enable pins by setting IO mux to 0 */
226 regmap_update_bits(sdhci_am654->base, PHY_CTRL1,
227 IOMUX_ENABLE_MASK, 0);
229 /* Set slot type based on SD or eMMC */
230 if (host->mmc->caps & MMC_CAP_NONREMOVABLE)
231 ctl_cfg_2 = SLOTTYPE_EMBEDDED;
233 regmap_update_bits(sdhci_am654->base, CTL_CFG_2,
234 SLOTTYPE_MASK, ctl_cfg_2);
236 return sdhci_add_host(host);
239 static int sdhci_am654_get_of_property(struct platform_device *pdev,
240 struct sdhci_am654_data *sdhci_am654)
242 struct device *dev = &pdev->dev;
246 ret = device_property_read_u32(dev, "ti,trm-icp",
247 &sdhci_am654->trm_icp);
251 ret = device_property_read_u32(dev, "ti,otap-del-sel",
252 &sdhci_am654->otap_del_sel);
256 ret = device_property_read_u32(dev, "ti,driver-strength-ohm",
261 switch (drv_strength) {
263 sdhci_am654->drv_strength = DRIVER_STRENGTH_50_OHM;
266 sdhci_am654->drv_strength = DRIVER_STRENGTH_33_OHM;
269 sdhci_am654->drv_strength = DRIVER_STRENGTH_66_OHM;
272 sdhci_am654->drv_strength = DRIVER_STRENGTH_100_OHM;
275 sdhci_am654->drv_strength = DRIVER_STRENGTH_40_OHM;
278 dev_err(dev, "Invalid driver strength\n");
282 sdhci_get_of_property(pdev);
287 static int sdhci_am654_probe(struct platform_device *pdev)
289 struct sdhci_pltfm_host *pltfm_host;
290 struct sdhci_am654_data *sdhci_am654;
291 struct sdhci_host *host;
292 struct resource *res;
294 struct device *dev = &pdev->dev;
298 host = sdhci_pltfm_init(pdev, &sdhci_am654_pdata, sizeof(*sdhci_am654));
300 return PTR_ERR(host);
302 pltfm_host = sdhci_priv(host);
303 sdhci_am654 = sdhci_pltfm_priv(pltfm_host);
305 clk_xin = devm_clk_get(dev, "clk_xin");
306 if (IS_ERR(clk_xin)) {
307 dev_err(dev, "clk_xin clock not found.\n");
308 ret = PTR_ERR(clk_xin);
312 pltfm_host->clk = clk_xin;
314 /* Clocks are enabled using pm_runtime */
315 pm_runtime_enable(dev);
316 ret = pm_runtime_get_sync(dev);
318 pm_runtime_put_noidle(dev);
319 goto pm_runtime_disable;
322 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
323 base = devm_ioremap_resource(dev, res);
329 sdhci_am654->base = devm_regmap_init_mmio(dev, base,
330 &sdhci_am654_regmap_config);
331 if (IS_ERR(sdhci_am654->base)) {
332 dev_err(dev, "Failed to initialize regmap\n");
333 ret = PTR_ERR(sdhci_am654->base);
337 ret = sdhci_am654_get_of_property(pdev, sdhci_am654);
341 ret = mmc_of_parse(host->mmc);
343 dev_err(dev, "parsing dt failed (%d)\n", ret);
347 ret = sdhci_am654_init(host);
354 pm_runtime_put_sync(dev);
356 pm_runtime_disable(dev);
358 sdhci_pltfm_free(pdev);
362 static int sdhci_am654_remove(struct platform_device *pdev)
364 struct sdhci_host *host = platform_get_drvdata(pdev);
367 sdhci_remove_host(host, true);
368 ret = pm_runtime_put_sync(&pdev->dev);
372 pm_runtime_disable(&pdev->dev);
373 sdhci_pltfm_free(pdev);
378 static const struct of_device_id sdhci_am654_of_match[] = {
379 { .compatible = "ti,am654-sdhci-5.1" },
383 static struct platform_driver sdhci_am654_driver = {
385 .name = "sdhci-am654",
386 .of_match_table = sdhci_am654_of_match,
388 .probe = sdhci_am654_probe,
389 .remove = sdhci_am654_remove,
392 module_platform_driver(sdhci_am654_driver);
394 MODULE_DESCRIPTION("Driver for SDHCI Controller on TI's AM654 devices");
395 MODULE_AUTHOR("Faiz Abbas <faiz_abbas@ti.com>");
396 MODULE_LICENSE("GPL");