1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Copyright (C) 2019 ASPEED Technology Inc. */
3 /* Copyright (C) 2019 IBM Corp. */
6 #include <linux/delay.h>
7 #include <linux/device.h>
9 #include <linux/math64.h>
10 #include <linux/mmc/host.h>
11 #include <linux/module.h>
12 #include <linux/of_address.h>
14 #include <linux/of_platform.h>
15 #include <linux/platform_device.h>
16 #include <linux/spinlock.h>
18 #include "sdhci-pltfm.h"
20 #define ASPEED_SDC_INFO 0x00
21 #define ASPEED_SDC_S1_MMC8 BIT(25)
22 #define ASPEED_SDC_S0_MMC8 BIT(24)
23 #define ASPEED_SDC_PHASE 0xf4
24 #define ASPEED_SDC_S1_PHASE_IN GENMASK(25, 21)
25 #define ASPEED_SDC_S0_PHASE_IN GENMASK(20, 16)
26 #define ASPEED_SDC_S1_PHASE_OUT GENMASK(15, 11)
27 #define ASPEED_SDC_S1_PHASE_IN_EN BIT(10)
28 #define ASPEED_SDC_S1_PHASE_OUT_EN GENMASK(9, 8)
29 #define ASPEED_SDC_S0_PHASE_OUT GENMASK(7, 3)
30 #define ASPEED_SDC_S0_PHASE_IN_EN BIT(2)
31 #define ASPEED_SDC_S0_PHASE_OUT_EN GENMASK(1, 0)
32 #define ASPEED_SDC_PHASE_MAX 31
42 struct aspeed_sdhci_tap_param {
45 #define ASPEED_SDHCI_TAP_PARAM_INVERT_CLK BIT(4)
50 struct aspeed_sdhci_tap_desc {
56 struct aspeed_sdhci_phase_desc {
57 struct aspeed_sdhci_tap_desc in;
58 struct aspeed_sdhci_tap_desc out;
61 struct aspeed_sdhci_pdata {
62 unsigned int clk_div_start;
63 const struct aspeed_sdhci_phase_desc *phase_desc;
64 size_t nr_phase_descs;
68 const struct aspeed_sdhci_pdata *pdata;
69 struct aspeed_sdc *parent;
71 struct mmc_clk_phase_map phase_map;
72 const struct aspeed_sdhci_phase_desc *phase_desc;
75 static void aspeed_sdc_configure_8bit_mode(struct aspeed_sdc *sdc,
76 struct aspeed_sdhci *sdhci,
81 /* Set/clear 8 bit mode */
82 spin_lock(&sdc->lock);
83 info = readl(sdc->regs + ASPEED_SDC_INFO);
85 info |= sdhci->width_mask;
87 info &= ~sdhci->width_mask;
88 writel(info, sdc->regs + ASPEED_SDC_INFO);
89 spin_unlock(&sdc->lock);
93 aspeed_sdc_set_phase_tap(const struct aspeed_sdhci_tap_desc *desc,
94 u8 tap, bool enable, u32 reg)
96 reg &= ~(desc->enable_mask | desc->tap_mask);
98 reg |= tap << __ffs(desc->tap_mask);
99 reg |= desc->enable_value << __ffs(desc->enable_mask);
106 aspeed_sdc_set_phase_taps(struct aspeed_sdc *sdc,
107 const struct aspeed_sdhci_phase_desc *desc,
108 const struct aspeed_sdhci_tap_param *taps)
112 spin_lock(&sdc->lock);
113 reg = readl(sdc->regs + ASPEED_SDC_PHASE);
115 reg = aspeed_sdc_set_phase_tap(&desc->in, taps->in, taps->valid, reg);
116 reg = aspeed_sdc_set_phase_tap(&desc->out, taps->out, taps->valid, reg);
118 writel(reg, sdc->regs + ASPEED_SDC_PHASE);
119 spin_unlock(&sdc->lock);
122 #define PICOSECONDS_PER_SECOND 1000000000000ULL
123 #define ASPEED_SDHCI_NR_TAPS 15
124 /* Measured value with *handwave* environmentals and static loading */
125 #define ASPEED_SDHCI_MAX_TAP_DELAY_PS 1253
126 static int aspeed_sdhci_phase_to_tap(struct device *dev, unsigned long rate_hz,
137 if (phase_deg >= 180) {
138 inverted = ASPEED_SDHCI_TAP_PARAM_INVERT_CLK;
141 "Inverting clock to reduce phase correction from %d to %d degrees\n",
142 phase_deg + 180, phase_deg);
147 prop_delay_ps = ASPEED_SDHCI_MAX_TAP_DELAY_PS / ASPEED_SDHCI_NR_TAPS;
148 clk_period_ps = div_u64(PICOSECONDS_PER_SECOND, (u64)rate_hz);
149 phase_period_ps = div_u64((u64)phase_deg * clk_period_ps, 360ULL);
151 tap = div_u64(phase_period_ps, prop_delay_ps);
152 if (tap > ASPEED_SDHCI_NR_TAPS) {
154 "Requested out of range phase tap %d for %d degrees of phase compensation at %luHz, clamping to tap %d\n",
155 tap, phase_deg, rate_hz, ASPEED_SDHCI_NR_TAPS);
156 tap = ASPEED_SDHCI_NR_TAPS;
159 return inverted | tap;
163 aspeed_sdhci_phases_to_taps(struct device *dev, unsigned long rate,
164 const struct mmc_clk_phase *phases,
165 struct aspeed_sdhci_tap_param *taps)
167 taps->valid = phases->valid;
172 taps->in = aspeed_sdhci_phase_to_tap(dev, rate, phases->in_deg);
173 taps->out = aspeed_sdhci_phase_to_tap(dev, rate, phases->out_deg);
177 aspeed_sdhci_configure_phase(struct sdhci_host *host, unsigned long rate)
179 struct aspeed_sdhci_tap_param _taps = {0}, *taps = &_taps;
180 struct mmc_clk_phase *params;
181 struct aspeed_sdhci *sdhci;
184 dev = mmc_dev(host->mmc);
185 sdhci = sdhci_pltfm_priv(sdhci_priv(host));
187 if (!sdhci->phase_desc)
190 params = &sdhci->phase_map.phase[host->timing];
191 aspeed_sdhci_phases_to_taps(dev, rate, params, taps);
192 aspeed_sdc_set_phase_taps(sdhci->parent, sdhci->phase_desc, taps);
194 "Using taps [%d, %d] for [%d, %d] degrees of phase correction at %luHz (%d)\n",
195 taps->in & ASPEED_SDHCI_NR_TAPS,
196 taps->out & ASPEED_SDHCI_NR_TAPS,
197 params->in_deg, params->out_deg, rate, host->timing);
200 static void aspeed_sdhci_set_clock(struct sdhci_host *host, unsigned int clock)
202 struct sdhci_pltfm_host *pltfm_host;
203 unsigned long parent, bus;
204 struct aspeed_sdhci *sdhci;
208 pltfm_host = sdhci_priv(host);
209 sdhci = sdhci_pltfm_priv(pltfm_host);
211 parent = clk_get_rate(pltfm_host->clk);
213 sdhci_writew(host, 0, SDHCI_CLOCK_CONTROL);
218 if (WARN_ON(clock > host->max_clk))
219 clock = host->max_clk;
222 * Regarding the AST2600:
224 * If (EMMC12C[7:6], EMMC12C[15:8] == 0) then
225 * period of SDCLK = period of SDMCLK.
227 * If (EMMC12C[7:6], EMMC12C[15:8] != 0) then
228 * period of SDCLK = period of SDMCLK * 2 * (EMMC12C[7:6], EMMC[15:8])
230 * If you keep EMMC12C[7:6] = 0 and EMMC12C[15:8] as one-hot,
231 * 0x1/0x2/0x4/etc, you will find it is compatible to AST2400 or AST2500
233 * Keep the one-hot behaviour for backwards compatibility except for
234 * supporting the value 0 in (EMMC12C[7:6], EMMC12C[15:8]), and capture
235 * the 0-value capability in clk_div_start.
237 for (div = sdhci->pdata->clk_div_start; div < 256; div *= 2) {
245 clk = div << SDHCI_DIVIDER_SHIFT;
247 aspeed_sdhci_configure_phase(host, bus);
249 sdhci_enable_clk(host, clk);
252 static unsigned int aspeed_sdhci_get_max_clock(struct sdhci_host *host)
254 if (host->mmc->f_max)
255 return host->mmc->f_max;
257 return sdhci_pltfm_clk_get_max_clock(host);
260 static void aspeed_sdhci_set_bus_width(struct sdhci_host *host, int width)
262 struct sdhci_pltfm_host *pltfm_priv;
263 struct aspeed_sdhci *aspeed_sdhci;
264 struct aspeed_sdc *aspeed_sdc;
267 pltfm_priv = sdhci_priv(host);
268 aspeed_sdhci = sdhci_pltfm_priv(pltfm_priv);
269 aspeed_sdc = aspeed_sdhci->parent;
271 /* Set/clear 8-bit mode */
272 aspeed_sdc_configure_8bit_mode(aspeed_sdc, aspeed_sdhci,
273 width == MMC_BUS_WIDTH_8);
275 /* Set/clear 1 or 4 bit mode */
276 ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL);
277 if (width == MMC_BUS_WIDTH_4)
278 ctrl |= SDHCI_CTRL_4BITBUS;
280 ctrl &= ~SDHCI_CTRL_4BITBUS;
281 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL);
284 static u32 aspeed_sdhci_readl(struct sdhci_host *host, int reg)
286 u32 val = readl(host->ioaddr + reg);
288 if (unlikely(reg == SDHCI_PRESENT_STATE) &&
289 (host->mmc->caps2 & MMC_CAP2_CD_ACTIVE_HIGH))
290 val ^= SDHCI_CARD_PRESENT;
295 static const struct sdhci_ops aspeed_sdhci_ops = {
296 .read_l = aspeed_sdhci_readl,
297 .set_clock = aspeed_sdhci_set_clock,
298 .get_max_clock = aspeed_sdhci_get_max_clock,
299 .set_bus_width = aspeed_sdhci_set_bus_width,
300 .get_timeout_clock = sdhci_pltfm_clk_get_max_clock,
301 .reset = sdhci_reset,
302 .set_uhs_signaling = sdhci_set_uhs_signaling,
305 static const struct sdhci_pltfm_data aspeed_sdhci_pdata = {
306 .ops = &aspeed_sdhci_ops,
307 .quirks = SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN,
310 static inline int aspeed_sdhci_calculate_slot(struct aspeed_sdhci *dev,
311 struct resource *res)
313 resource_size_t delta;
315 if (!res || resource_type(res) != IORESOURCE_MEM)
318 if (res->start < dev->parent->res->start)
321 delta = res->start - dev->parent->res->start;
322 if (delta & (0x100 - 1))
325 return (delta / 0x100) - 1;
328 static int aspeed_sdhci_probe(struct platform_device *pdev)
330 const struct aspeed_sdhci_pdata *aspeed_pdata;
331 struct sdhci_pltfm_host *pltfm_host;
332 struct aspeed_sdhci *dev;
333 struct sdhci_host *host;
334 struct resource *res;
338 aspeed_pdata = of_device_get_match_data(&pdev->dev);
340 dev_err(&pdev->dev, "Missing platform configuration data\n");
344 host = sdhci_pltfm_init(pdev, &aspeed_sdhci_pdata, sizeof(*dev));
346 return PTR_ERR(host);
348 pltfm_host = sdhci_priv(host);
349 dev = sdhci_pltfm_priv(pltfm_host);
350 dev->pdata = aspeed_pdata;
351 dev->parent = dev_get_drvdata(pdev->dev.parent);
353 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
354 slot = aspeed_sdhci_calculate_slot(dev, res);
361 if (slot < dev->pdata->nr_phase_descs) {
362 dev->phase_desc = &dev->pdata->phase_desc[slot];
365 "Phase control not supported for slot %d\n", slot);
366 dev->phase_desc = NULL;
369 dev->width_mask = !slot ? ASPEED_SDC_S0_MMC8 : ASPEED_SDC_S1_MMC8;
371 dev_info(&pdev->dev, "Configured for slot %d\n", slot);
373 sdhci_get_of_property(pdev);
375 pltfm_host->clk = devm_clk_get(&pdev->dev, NULL);
376 if (IS_ERR(pltfm_host->clk))
377 return PTR_ERR(pltfm_host->clk);
379 ret = clk_prepare_enable(pltfm_host->clk);
381 dev_err(&pdev->dev, "Unable to enable SDIO clock\n");
385 ret = mmc_of_parse(host->mmc);
390 mmc_of_parse_clk_phase(host->mmc, &dev->phase_map);
392 ret = sdhci_add_host(host);
399 clk_disable_unprepare(pltfm_host->clk);
401 sdhci_pltfm_free(pdev);
405 static int aspeed_sdhci_remove(struct platform_device *pdev)
407 struct sdhci_pltfm_host *pltfm_host;
408 struct sdhci_host *host;
411 host = platform_get_drvdata(pdev);
412 pltfm_host = sdhci_priv(host);
414 sdhci_remove_host(host, dead);
416 clk_disable_unprepare(pltfm_host->clk);
418 sdhci_pltfm_free(pdev);
423 static const struct aspeed_sdhci_pdata ast2400_sdhci_pdata = {
427 static const struct aspeed_sdhci_phase_desc ast2600_sdhci_phase[] = {
431 .tap_mask = ASPEED_SDC_S0_PHASE_IN,
432 .enable_mask = ASPEED_SDC_S0_PHASE_IN_EN,
436 .tap_mask = ASPEED_SDC_S0_PHASE_OUT,
437 .enable_mask = ASPEED_SDC_S0_PHASE_OUT_EN,
444 .tap_mask = ASPEED_SDC_S1_PHASE_IN,
445 .enable_mask = ASPEED_SDC_S1_PHASE_IN_EN,
449 .tap_mask = ASPEED_SDC_S1_PHASE_OUT,
450 .enable_mask = ASPEED_SDC_S1_PHASE_OUT_EN,
456 static const struct aspeed_sdhci_pdata ast2600_sdhci_pdata = {
458 .phase_desc = ast2600_sdhci_phase,
459 .nr_phase_descs = ARRAY_SIZE(ast2600_sdhci_phase),
462 static const struct of_device_id aspeed_sdhci_of_match[] = {
463 { .compatible = "aspeed,ast2400-sdhci", .data = &ast2400_sdhci_pdata, },
464 { .compatible = "aspeed,ast2500-sdhci", .data = &ast2400_sdhci_pdata, },
465 { .compatible = "aspeed,ast2600-sdhci", .data = &ast2600_sdhci_pdata, },
469 static struct platform_driver aspeed_sdhci_driver = {
471 .name = "sdhci-aspeed",
472 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
473 .of_match_table = aspeed_sdhci_of_match,
475 .probe = aspeed_sdhci_probe,
476 .remove = aspeed_sdhci_remove,
479 static int aspeed_sdc_probe(struct platform_device *pdev)
482 struct device_node *parent, *child;
483 struct aspeed_sdc *sdc;
486 sdc = devm_kzalloc(&pdev->dev, sizeof(*sdc), GFP_KERNEL);
490 spin_lock_init(&sdc->lock);
492 sdc->clk = devm_clk_get(&pdev->dev, NULL);
493 if (IS_ERR(sdc->clk))
494 return PTR_ERR(sdc->clk);
496 ret = clk_prepare_enable(sdc->clk);
498 dev_err(&pdev->dev, "Unable to enable SDCLK\n");
502 sdc->res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
503 sdc->regs = devm_ioremap_resource(&pdev->dev, sdc->res);
504 if (IS_ERR(sdc->regs)) {
505 ret = PTR_ERR(sdc->regs);
509 dev_set_drvdata(&pdev->dev, sdc);
511 parent = pdev->dev.of_node;
512 for_each_available_child_of_node(parent, child) {
513 struct platform_device *cpdev;
515 cpdev = of_platform_device_create(child, NULL, &pdev->dev);
526 clk_disable_unprepare(sdc->clk);
530 static int aspeed_sdc_remove(struct platform_device *pdev)
532 struct aspeed_sdc *sdc = dev_get_drvdata(&pdev->dev);
534 clk_disable_unprepare(sdc->clk);
539 static const struct of_device_id aspeed_sdc_of_match[] = {
540 { .compatible = "aspeed,ast2400-sd-controller", },
541 { .compatible = "aspeed,ast2500-sd-controller", },
542 { .compatible = "aspeed,ast2600-sd-controller", },
546 MODULE_DEVICE_TABLE(of, aspeed_sdc_of_match);
548 static struct platform_driver aspeed_sdc_driver = {
550 .name = "sd-controller-aspeed",
551 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
552 .pm = &sdhci_pltfm_pmops,
553 .of_match_table = aspeed_sdc_of_match,
555 .probe = aspeed_sdc_probe,
556 .remove = aspeed_sdc_remove,
559 #if defined(CONFIG_MMC_SDHCI_OF_ASPEED_TEST)
560 #include "sdhci-of-aspeed-test.c"
562 static inline int aspeed_sdc_tests_init(void)
564 return __kunit_test_suites_init(aspeed_sdc_test_suites);
567 static inline void aspeed_sdc_tests_exit(void)
569 __kunit_test_suites_exit(aspeed_sdc_test_suites);
572 static inline int aspeed_sdc_tests_init(void)
577 static inline void aspeed_sdc_tests_exit(void)
582 static int __init aspeed_sdc_init(void)
586 rc = platform_driver_register(&aspeed_sdhci_driver);
590 rc = platform_driver_register(&aspeed_sdc_driver);
594 rc = aspeed_sdc_tests_init();
596 platform_driver_unregister(&aspeed_sdc_driver);
603 platform_driver_unregister(&aspeed_sdhci_driver);
607 module_init(aspeed_sdc_init);
609 static void __exit aspeed_sdc_exit(void)
611 aspeed_sdc_tests_exit();
613 platform_driver_unregister(&aspeed_sdc_driver);
614 platform_driver_unregister(&aspeed_sdhci_driver);
616 module_exit(aspeed_sdc_exit);
618 MODULE_DESCRIPTION("Driver for the ASPEED SD/SDIO/SDHCI Controllers");
621 MODULE_LICENSE("GPL");