4 * Copyright (C) 2015-17 Renesas Electronics Corporation
5 * Copyright (C) 2016-17 Sang Engineering, Wolfram Sang
6 * Copyright (C) 2016-17 Horms Solutions, Simon Horman
7 * Copyright (C) 2009 Magnus Damm
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * Based on "Compaq ASIC3 support":
15 * Copyright 2001 Compaq Computer Corporation.
16 * Copyright 2004-2005 Phil Blundell
17 * Copyright 2007-2008 OpenedHand Ltd.
19 * Authors: Phil Blundell <pb@handhelds.org>,
20 * Samuel Ortiz <sameo@openedhand.com>
24 #include <linux/kernel.h>
25 #include <linux/clk.h>
26 #include <linux/slab.h>
27 #include <linux/of_device.h>
28 #include <linux/platform_device.h>
29 #include <linux/mmc/host.h>
30 #include <linux/mfd/tmio.h>
31 #include <linux/sh_dma.h>
32 #include <linux/delay.h>
33 #include <linux/pinctrl/consumer.h>
34 #include <linux/pinctrl/pinctrl-state.h>
35 #include <linux/regulator/consumer.h>
37 #include "renesas_sdhi.h"
42 #define SDHI_VER_GEN2_SDR50 0x490c
43 #define SDHI_VER_RZ_A1 0x820b
44 /* very old datasheets said 0x490c for SDR104, too. They are wrong! */
45 #define SDHI_VER_GEN2_SDR104 0xcb0d
46 #define SDHI_VER_GEN3_SD 0xcc10
47 #define SDHI_VER_GEN3_SDMMC 0xcd10
49 #define host_to_priv(host) \
50 container_of((host)->pdata, struct renesas_sdhi, mmc_data)
55 struct tmio_mmc_data mmc_data;
56 struct tmio_mmc_dma dma_priv;
57 struct pinctrl *pinctrl;
58 struct pinctrl_state *pins_default, *pins_uhs;
59 void __iomem *scc_ctl;
62 static void renesas_sdhi_sdbuf_width(struct tmio_mmc_host *host, int width)
68 * renesas_sdhi_of_data :: dma_buswidth
70 switch (sd_ctrl_read16(host, CTL_VERSION)) {
71 case SDHI_VER_GEN2_SDR50:
72 val = (width == 32) ? 0x0001 : 0x0000;
74 case SDHI_VER_GEN2_SDR104:
75 val = (width == 32) ? 0x0000 : 0x0001;
77 case SDHI_VER_GEN3_SD:
78 case SDHI_VER_GEN3_SDMMC:
91 sd_ctrl_write16(host, EXT_ACC, val);
94 static int renesas_sdhi_clk_enable(struct tmio_mmc_host *host)
96 struct mmc_host *mmc = host->mmc;
97 struct renesas_sdhi *priv = host_to_priv(host);
98 int ret = clk_prepare_enable(priv->clk);
103 ret = clk_prepare_enable(priv->clk_cd);
105 clk_disable_unprepare(priv->clk);
110 * The clock driver may not know what maximum frequency
111 * actually works, so it should be set with the max-frequency
112 * property which will already have been read to f_max. If it
113 * was missing, assume the current frequency is the maximum.
116 mmc->f_max = clk_get_rate(priv->clk);
119 * Minimum frequency is the minimum input clock frequency
120 * divided by our maximum divider.
122 mmc->f_min = max(clk_round_rate(priv->clk, 1) / 512, 1L);
124 /* enable 16bit data access on SDBUF as default */
125 renesas_sdhi_sdbuf_width(host, 16);
130 static unsigned int renesas_sdhi_clk_update(struct tmio_mmc_host *host,
131 unsigned int new_clock)
133 struct renesas_sdhi *priv = host_to_priv(host);
134 unsigned int freq, diff, best_freq = 0, diff_min = ~0;
137 /* tested only on R-Car Gen2+ currently; may work for others */
138 if (!(host->pdata->flags & TMIO_MMC_MIN_RCAR2))
139 return clk_get_rate(priv->clk);
142 * We want the bus clock to be as close as possible to, but no
143 * greater than, new_clock. As we can divide by 1 << i for
144 * any i in [0, 9] we want the input clock to be as close as
145 * possible, but no greater than, new_clock << i.
147 for (i = min(9, ilog2(UINT_MAX / new_clock)); i >= 0; i--) {
148 freq = clk_round_rate(priv->clk, new_clock << i);
149 if (freq > (new_clock << i)) {
150 /* Too fast; look for a slightly slower option */
151 freq = clk_round_rate(priv->clk,
152 (new_clock << i) / 4 * 3);
153 if (freq > (new_clock << i))
157 diff = new_clock - (freq >> i);
158 if (diff <= diff_min) {
164 ret = clk_set_rate(priv->clk, best_freq);
166 return ret == 0 ? best_freq : clk_get_rate(priv->clk);
169 static void renesas_sdhi_clk_disable(struct tmio_mmc_host *host)
171 struct renesas_sdhi *priv = host_to_priv(host);
173 clk_disable_unprepare(priv->clk);
174 clk_disable_unprepare(priv->clk_cd);
177 static int renesas_sdhi_card_busy(struct mmc_host *mmc)
179 struct tmio_mmc_host *host = mmc_priv(mmc);
181 return !(sd_ctrl_read16_and_16_as_32(host, CTL_STATUS) &
185 static int renesas_sdhi_start_signal_voltage_switch(struct mmc_host *mmc,
188 struct tmio_mmc_host *host = mmc_priv(mmc);
189 struct renesas_sdhi *priv = host_to_priv(host);
190 struct pinctrl_state *pin_state;
193 switch (ios->signal_voltage) {
194 case MMC_SIGNAL_VOLTAGE_330:
195 pin_state = priv->pins_default;
197 case MMC_SIGNAL_VOLTAGE_180:
198 pin_state = priv->pins_uhs;
205 * If anything is missing, assume signal voltage is fixed at
206 * 3.3V and succeed/fail accordingly.
208 if (IS_ERR(priv->pinctrl) || IS_ERR(pin_state))
209 return ios->signal_voltage ==
210 MMC_SIGNAL_VOLTAGE_330 ? 0 : -EINVAL;
212 ret = mmc_regulator_set_vqmmc(host->mmc, ios);
216 return pinctrl_select_state(priv->pinctrl, pin_state);
220 #define SH_MOBILE_SDHI_SCC_DTCNTL 0x000
221 #define SH_MOBILE_SDHI_SCC_TAPSET 0x002
222 #define SH_MOBILE_SDHI_SCC_DT2FF 0x004
223 #define SH_MOBILE_SDHI_SCC_CKSEL 0x006
224 #define SH_MOBILE_SDHI_SCC_RVSCNTL 0x008
225 #define SH_MOBILE_SDHI_SCC_RVSREQ 0x00A
227 /* Definitions for values the SH_MOBILE_SDHI_SCC_DTCNTL register */
228 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN BIT(0)
229 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT 16
230 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_MASK 0xff
232 /* Definitions for values the SH_MOBILE_SDHI_SCC_CKSEL register */
233 #define SH_MOBILE_SDHI_SCC_CKSEL_DTSEL BIT(0)
234 /* Definitions for values the SH_MOBILE_SDHI_SCC_RVSCNTL register */
235 #define SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN BIT(0)
236 /* Definitions for values the SH_MOBILE_SDHI_SCC_RVSREQ register */
237 #define SH_MOBILE_SDHI_SCC_RVSREQ_RVSERR BIT(2)
239 static inline u32 sd_scc_read32(struct tmio_mmc_host *host,
240 struct renesas_sdhi *priv, int addr)
242 return readl(priv->scc_ctl + (addr << host->bus_shift));
245 static inline void sd_scc_write32(struct tmio_mmc_host *host,
246 struct renesas_sdhi *priv,
249 writel(val, priv->scc_ctl + (addr << host->bus_shift));
252 static unsigned int renesas_sdhi_init_tuning(struct tmio_mmc_host *host)
254 struct renesas_sdhi *priv;
256 priv = host_to_priv(host);
258 /* set sampling clock selection range */
259 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL,
260 0x8 << SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT);
263 sd_ctrl_write32_as_16_and_16(host, CTL_STATUS, 0x0);
265 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL,
266 SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN |
267 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL));
269 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
270 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
272 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL,
273 SH_MOBILE_SDHI_SCC_CKSEL_DTSEL |
274 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL));
276 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
277 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
279 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
280 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
281 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
283 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DT2FF, host->scc_tappos);
286 return (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL) >>
287 SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT) &
288 SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_MASK;
291 static void renesas_sdhi_prepare_tuning(struct tmio_mmc_host *host,
294 struct renesas_sdhi *priv = host_to_priv(host);
296 /* Set sampling clock position */
297 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET, tap);
300 #define SH_MOBILE_SDHI_MAX_TAP 3
302 static int renesas_sdhi_select_tuning(struct tmio_mmc_host *host)
304 struct renesas_sdhi *priv = host_to_priv(host);
305 unsigned long tap_cnt; /* counter of tuning success */
306 unsigned long tap_set; /* tap position */
307 unsigned long tap_start;/* start position of tuning success */
308 unsigned long tap_end; /* end position of tuning success */
309 unsigned long ntap; /* temporary counter of tuning success */
312 /* Clear SCC_RVSREQ */
313 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ, 0);
316 * Find the longest consecutive run of successful probes. If that
317 * is more than SH_MOBILE_SDHI_MAX_TAP probes long then use the
318 * center index as the tap.
324 for (i = 0; i < host->tap_num * 2; i++) {
325 if (test_bit(i, host->taps)) {
328 if (ntap > tap_cnt) {
329 tap_start = i - ntap;
337 if (ntap > tap_cnt) {
338 tap_start = i - ntap;
343 if (tap_cnt >= SH_MOBILE_SDHI_MAX_TAP)
344 tap_set = (tap_start + tap_end) / 2 % host->tap_num;
349 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET, tap_set);
351 /* Enable auto re-tuning */
352 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
353 SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN |
354 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
359 static bool renesas_sdhi_check_scc_error(struct tmio_mmc_host *host)
361 struct renesas_sdhi *priv = host_to_priv(host);
363 /* Check SCC error */
364 if (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL) &
365 SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &&
366 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ) &
367 SH_MOBILE_SDHI_SCC_RVSREQ_RVSERR) {
368 /* Clear SCC error */
369 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ, 0);
376 static void renesas_sdhi_hw_reset(struct tmio_mmc_host *host)
378 struct renesas_sdhi *priv;
380 priv = host_to_priv(host);
383 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
384 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
386 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL,
387 ~SH_MOBILE_SDHI_SCC_CKSEL_DTSEL &
388 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL));
390 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
391 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
393 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
394 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
395 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
397 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
398 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
399 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
402 static int renesas_sdhi_wait_idle(struct tmio_mmc_host *host, u32 bit)
405 /* CBSY is set when busy, SCLKDIVEN is cleared when busy */
406 u32 wait_state = (bit == TMIO_STAT_CMD_BUSY ? TMIO_STAT_CMD_BUSY : 0);
408 while (--timeout && (sd_ctrl_read16_and_16_as_32(host, CTL_STATUS)
409 & bit) == wait_state)
413 dev_warn(&host->pdev->dev, "timeout waiting for SD bus idle\n");
420 static int renesas_sdhi_write16_hook(struct tmio_mmc_host *host, int addr)
422 u32 bit = TMIO_STAT_SCLKDIVEN;
426 case CTL_STOP_INTERNAL_ACTION:
427 case CTL_XFER_BLK_COUNT:
428 case CTL_SD_XFER_LEN:
429 case CTL_SD_MEM_CARD_OPT:
430 case CTL_TRANSACTION_CTL:
433 if (host->pdata->flags & TMIO_MMC_HAVE_CBSY)
434 bit = TMIO_STAT_CMD_BUSY;
436 case CTL_SD_CARD_CLK_CTL:
437 return renesas_sdhi_wait_idle(host, bit);
443 static int renesas_sdhi_multi_io_quirk(struct mmc_card *card,
444 unsigned int direction, int blk_size)
447 * In Renesas controllers, when performing a
448 * multiple block read of one or two blocks,
449 * depending on the timing with which the
450 * response register is read, the response
451 * value may not be read properly.
452 * Use single block read for this HW bug
454 if ((direction == MMC_DATA_READ) &&
461 static void renesas_sdhi_enable_dma(struct tmio_mmc_host *host, bool enable)
463 /* Iff regs are 8 byte apart, sdbuf is 64 bit. Otherwise always 32. */
464 int width = (host->bus_shift == 2) ? 64 : 32;
466 sd_ctrl_write16(host, CTL_DMA_ENABLE, enable ? DMA_ENABLE_DMASDRW : 0);
467 renesas_sdhi_sdbuf_width(host, enable ? width : 16);
470 int renesas_sdhi_probe(struct platform_device *pdev,
471 const struct tmio_mmc_dma_ops *dma_ops)
473 struct tmio_mmc_data *mmd = pdev->dev.platform_data;
474 const struct renesas_sdhi_of_data *of_data;
475 struct tmio_mmc_data *mmc_data;
476 struct tmio_mmc_dma *dma_priv;
477 struct tmio_mmc_host *host;
478 struct renesas_sdhi *priv;
479 struct resource *res;
482 of_data = of_device_get_match_data(&pdev->dev);
484 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
488 priv = devm_kzalloc(&pdev->dev, sizeof(struct renesas_sdhi),
493 mmc_data = &priv->mmc_data;
494 dma_priv = &priv->dma_priv;
496 priv->clk = devm_clk_get(&pdev->dev, NULL);
497 if (IS_ERR(priv->clk)) {
498 ret = PTR_ERR(priv->clk);
499 dev_err(&pdev->dev, "cannot get clock: %d\n", ret);
504 * Some controllers provide a 2nd clock just to run the internal card
505 * detection logic. Unfortunately, the existing driver architecture does
506 * not support a separation of clocks for runtime PM usage. When
507 * native hotplug is used, the tmio driver assumes that the core
508 * must continue to run for card detect to stay active, so we cannot
510 * Additionally, it is prohibited to supply a clock to the core but not
511 * to the card detect circuit. That leaves us with if separate clocks
512 * are presented, we must treat them both as virtually 1 clock.
514 priv->clk_cd = devm_clk_get(&pdev->dev, "cd");
515 if (IS_ERR(priv->clk_cd))
518 priv->pinctrl = devm_pinctrl_get(&pdev->dev);
519 if (!IS_ERR(priv->pinctrl)) {
520 priv->pins_default = pinctrl_lookup_state(priv->pinctrl,
521 PINCTRL_STATE_DEFAULT);
522 priv->pins_uhs = pinctrl_lookup_state(priv->pinctrl,
526 host = tmio_mmc_host_alloc(pdev);
531 mmc_data->flags |= of_data->tmio_flags;
532 mmc_data->ocr_mask = of_data->tmio_ocr_mask;
533 mmc_data->capabilities |= of_data->capabilities;
534 mmc_data->capabilities2 |= of_data->capabilities2;
535 mmc_data->dma_rx_offset = of_data->dma_rx_offset;
536 mmc_data->max_blk_count = of_data->max_blk_count;
537 mmc_data->max_segs = of_data->max_segs;
538 dma_priv->dma_buswidth = of_data->dma_buswidth;
539 host->bus_shift = of_data->bus_shift;
542 host->dma = dma_priv;
543 host->write16_hook = renesas_sdhi_write16_hook;
544 host->clk_enable = renesas_sdhi_clk_enable;
545 host->clk_update = renesas_sdhi_clk_update;
546 host->clk_disable = renesas_sdhi_clk_disable;
547 host->multi_io_quirk = renesas_sdhi_multi_io_quirk;
549 /* SDR speeds are only available on Gen2+ */
550 if (mmc_data->flags & TMIO_MMC_MIN_RCAR2) {
551 /* card_busy caused issues on r8a73a4 (pre-Gen2) CD-less SDHI */
552 host->card_busy = renesas_sdhi_card_busy;
553 host->start_signal_voltage_switch =
554 renesas_sdhi_start_signal_voltage_switch;
557 /* Orginally registers were 16 bit apart, could be 32 or 64 nowadays */
558 if (!host->bus_shift && resource_size(res) > 0x100) /* old way to determine the shift */
564 dma_priv->filter = shdma_chan_filter;
565 dma_priv->enable = renesas_sdhi_enable_dma;
567 mmc_data->alignment_shift = 1; /* 2-byte alignment */
568 mmc_data->capabilities |= MMC_CAP_MMC_HIGHSPEED;
571 * All SDHI blocks support 2-byte and larger block sizes in 4-bit
574 mmc_data->flags |= TMIO_MMC_BLKSZ_2BYTES;
577 * All SDHI blocks support SDIO IRQ signalling.
579 mmc_data->flags |= TMIO_MMC_SDIO_IRQ;
581 /* All SDHI have CMD12 control bit */
582 mmc_data->flags |= TMIO_MMC_HAVE_CMD12_CTRL;
584 /* All SDHI have SDIO status bits which must be 1 */
585 mmc_data->flags |= TMIO_MMC_SDIO_STATUS_SETBITS;
587 ret = tmio_mmc_host_probe(host, mmc_data, dma_ops);
591 /* One Gen2 SDHI incarnation does NOT have a CBSY bit */
592 if (sd_ctrl_read16(host, CTL_VERSION) == SDHI_VER_GEN2_SDR50)
593 mmc_data->flags &= ~TMIO_MMC_HAVE_CBSY;
595 /* Enable tuning iff we have an SCC and a supported mode */
596 if (of_data && of_data->scc_offset &&
597 (host->mmc->caps & MMC_CAP_UHS_SDR104 ||
598 host->mmc->caps2 & MMC_CAP2_HS200_1_8V_SDR)) {
599 const struct renesas_sdhi_scc *taps = of_data->taps;
602 host->mmc->caps |= MMC_CAP_HW_RESET;
604 for (i = 0; i < of_data->taps_num; i++) {
605 if (taps[i].clk_rate == 0 ||
606 taps[i].clk_rate == host->mmc->f_max) {
607 host->scc_tappos = taps->tap;
614 dev_warn(&host->pdev->dev, "Unknown clock rate for SDR104\n");
616 priv->scc_ctl = host->ctl + of_data->scc_offset;
617 host->init_tuning = renesas_sdhi_init_tuning;
618 host->prepare_tuning = renesas_sdhi_prepare_tuning;
619 host->select_tuning = renesas_sdhi_select_tuning;
620 host->check_scc_error = renesas_sdhi_check_scc_error;
621 host->hw_reset = renesas_sdhi_hw_reset;
626 irq = platform_get_irq(pdev, i);
630 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq, 0,
631 dev_name(&pdev->dev), host);
636 /* There must be at least one IRQ source */
642 dev_info(&pdev->dev, "%s base at 0x%08lx max clock rate %u MHz\n",
643 mmc_hostname(host->mmc), (unsigned long)
644 (platform_get_resource(pdev, IORESOURCE_MEM, 0)->start),
645 host->mmc->f_max / 1000000);
650 tmio_mmc_host_remove(host);
652 tmio_mmc_host_free(host);
656 EXPORT_SYMBOL_GPL(renesas_sdhi_probe);
658 int renesas_sdhi_remove(struct platform_device *pdev)
660 struct mmc_host *mmc = platform_get_drvdata(pdev);
661 struct tmio_mmc_host *host = mmc_priv(mmc);
663 tmio_mmc_host_remove(host);
667 EXPORT_SYMBOL_GPL(renesas_sdhi_remove);