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/module.h>
28 #include <linux/of_device.h>
29 #include <linux/platform_device.h>
30 #include <linux/mmc/host.h>
31 #include <linux/mfd/tmio.h>
32 #include <linux/sh_dma.h>
33 #include <linux/delay.h>
34 #include <linux/pinctrl/consumer.h>
35 #include <linux/pinctrl/pinctrl-state.h>
36 #include <linux/regulator/consumer.h>
38 #include "renesas_sdhi.h"
43 #define SDHI_VER_GEN2_SDR50 0x490c
44 #define SDHI_VER_RZ_A1 0x820b
45 /* very old datasheets said 0x490c for SDR104, too. They are wrong! */
46 #define SDHI_VER_GEN2_SDR104 0xcb0d
47 #define SDHI_VER_GEN3_SD 0xcc10
48 #define SDHI_VER_GEN3_SDMMC 0xcd10
50 #define host_to_priv(host) \
51 container_of((host)->pdata, struct renesas_sdhi, mmc_data)
56 struct tmio_mmc_data mmc_data;
57 struct tmio_mmc_dma dma_priv;
58 struct pinctrl *pinctrl;
59 struct pinctrl_state *pins_default, *pins_uhs;
60 void __iomem *scc_ctl;
63 static void renesas_sdhi_sdbuf_width(struct tmio_mmc_host *host, int width)
69 * renesas_sdhi_of_data :: dma_buswidth
71 switch (sd_ctrl_read16(host, CTL_VERSION)) {
72 case SDHI_VER_GEN2_SDR50:
73 val = (width == 32) ? 0x0001 : 0x0000;
75 case SDHI_VER_GEN2_SDR104:
76 val = (width == 32) ? 0x0000 : 0x0001;
78 case SDHI_VER_GEN3_SD:
79 case SDHI_VER_GEN3_SDMMC:
92 sd_ctrl_write16(host, EXT_ACC, val);
95 static int renesas_sdhi_clk_enable(struct tmio_mmc_host *host)
97 struct mmc_host *mmc = host->mmc;
98 struct renesas_sdhi *priv = host_to_priv(host);
99 int ret = clk_prepare_enable(priv->clk);
104 ret = clk_prepare_enable(priv->clk_cd);
106 clk_disable_unprepare(priv->clk);
111 * The clock driver may not know what maximum frequency
112 * actually works, so it should be set with the max-frequency
113 * property which will already have been read to f_max. If it
114 * was missing, assume the current frequency is the maximum.
117 mmc->f_max = clk_get_rate(priv->clk);
120 * Minimum frequency is the minimum input clock frequency
121 * divided by our maximum divider.
123 mmc->f_min = max(clk_round_rate(priv->clk, 1) / 512, 1L);
125 /* enable 16bit data access on SDBUF as default */
126 renesas_sdhi_sdbuf_width(host, 16);
131 static unsigned int renesas_sdhi_clk_update(struct tmio_mmc_host *host,
132 unsigned int new_clock)
134 struct renesas_sdhi *priv = host_to_priv(host);
135 unsigned int freq, diff, best_freq = 0, diff_min = ~0;
138 /* tested only on R-Car Gen2+ currently; may work for others */
139 if (!(host->pdata->flags & TMIO_MMC_MIN_RCAR2))
140 return clk_get_rate(priv->clk);
143 * We want the bus clock to be as close as possible to, but no
144 * greater than, new_clock. As we can divide by 1 << i for
145 * any i in [0, 9] we want the input clock to be as close as
146 * possible, but no greater than, new_clock << i.
148 for (i = min(9, ilog2(UINT_MAX / new_clock)); i >= 0; i--) {
149 freq = clk_round_rate(priv->clk, new_clock << i);
150 if (freq > (new_clock << i)) {
151 /* Too fast; look for a slightly slower option */
152 freq = clk_round_rate(priv->clk,
153 (new_clock << i) / 4 * 3);
154 if (freq > (new_clock << i))
158 diff = new_clock - (freq >> i);
159 if (diff <= diff_min) {
165 ret = clk_set_rate(priv->clk, best_freq);
167 return ret == 0 ? best_freq : clk_get_rate(priv->clk);
170 static void renesas_sdhi_clk_disable(struct tmio_mmc_host *host)
172 struct renesas_sdhi *priv = host_to_priv(host);
174 clk_disable_unprepare(priv->clk);
175 clk_disable_unprepare(priv->clk_cd);
178 static int renesas_sdhi_card_busy(struct mmc_host *mmc)
180 struct tmio_mmc_host *host = mmc_priv(mmc);
182 return !(sd_ctrl_read16_and_16_as_32(host, CTL_STATUS) &
186 static int renesas_sdhi_start_signal_voltage_switch(struct mmc_host *mmc,
189 struct tmio_mmc_host *host = mmc_priv(mmc);
190 struct renesas_sdhi *priv = host_to_priv(host);
191 struct pinctrl_state *pin_state;
194 switch (ios->signal_voltage) {
195 case MMC_SIGNAL_VOLTAGE_330:
196 pin_state = priv->pins_default;
198 case MMC_SIGNAL_VOLTAGE_180:
199 pin_state = priv->pins_uhs;
206 * If anything is missing, assume signal voltage is fixed at
207 * 3.3V and succeed/fail accordingly.
209 if (IS_ERR(priv->pinctrl) || IS_ERR(pin_state))
210 return ios->signal_voltage ==
211 MMC_SIGNAL_VOLTAGE_330 ? 0 : -EINVAL;
213 ret = mmc_regulator_set_vqmmc(host->mmc, ios);
217 return pinctrl_select_state(priv->pinctrl, pin_state);
221 #define SH_MOBILE_SDHI_SCC_DTCNTL 0x000
222 #define SH_MOBILE_SDHI_SCC_TAPSET 0x002
223 #define SH_MOBILE_SDHI_SCC_DT2FF 0x004
224 #define SH_MOBILE_SDHI_SCC_CKSEL 0x006
225 #define SH_MOBILE_SDHI_SCC_RVSCNTL 0x008
226 #define SH_MOBILE_SDHI_SCC_RVSREQ 0x00A
228 /* Definitions for values the SH_MOBILE_SDHI_SCC_DTCNTL register */
229 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN BIT(0)
230 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT 16
231 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_MASK 0xff
233 /* Definitions for values the SH_MOBILE_SDHI_SCC_CKSEL register */
234 #define SH_MOBILE_SDHI_SCC_CKSEL_DTSEL BIT(0)
235 /* Definitions for values the SH_MOBILE_SDHI_SCC_RVSCNTL register */
236 #define SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN BIT(0)
237 /* Definitions for values the SH_MOBILE_SDHI_SCC_RVSREQ register */
238 #define SH_MOBILE_SDHI_SCC_RVSREQ_RVSERR BIT(2)
240 static inline u32 sd_scc_read32(struct tmio_mmc_host *host,
241 struct renesas_sdhi *priv, int addr)
243 return readl(priv->scc_ctl + (addr << host->bus_shift));
246 static inline void sd_scc_write32(struct tmio_mmc_host *host,
247 struct renesas_sdhi *priv,
250 writel(val, priv->scc_ctl + (addr << host->bus_shift));
253 static unsigned int renesas_sdhi_init_tuning(struct tmio_mmc_host *host)
255 struct renesas_sdhi *priv;
257 priv = host_to_priv(host);
259 /* set sampling clock selection range */
260 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL,
261 0x8 << SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT);
264 sd_ctrl_write32_as_16_and_16(host, CTL_STATUS, 0x0);
266 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL,
267 SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN |
268 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL));
270 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
271 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
273 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL,
274 SH_MOBILE_SDHI_SCC_CKSEL_DTSEL |
275 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL));
277 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
278 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
280 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
281 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
282 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
284 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DT2FF, host->scc_tappos);
287 return (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL) >>
288 SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT) &
289 SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_MASK;
292 static void renesas_sdhi_prepare_tuning(struct tmio_mmc_host *host,
295 struct renesas_sdhi *priv = host_to_priv(host);
297 /* Set sampling clock position */
298 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET, tap);
301 #define SH_MOBILE_SDHI_MAX_TAP 3
303 static int renesas_sdhi_select_tuning(struct tmio_mmc_host *host)
305 struct renesas_sdhi *priv = host_to_priv(host);
306 unsigned long tap_cnt; /* counter of tuning success */
307 unsigned long tap_set; /* tap position */
308 unsigned long tap_start;/* start position of tuning success */
309 unsigned long tap_end; /* end position of tuning success */
310 unsigned long ntap; /* temporary counter of tuning success */
313 /* Clear SCC_RVSREQ */
314 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ, 0);
317 * Find the longest consecutive run of successful probes. If that
318 * is more than SH_MOBILE_SDHI_MAX_TAP probes long then use the
319 * center index as the tap.
325 for (i = 0; i < host->tap_num * 2; i++) {
326 if (test_bit(i, host->taps)) {
329 if (ntap > tap_cnt) {
330 tap_start = i - ntap;
338 if (ntap > tap_cnt) {
339 tap_start = i - ntap;
344 if (tap_cnt >= SH_MOBILE_SDHI_MAX_TAP)
345 tap_set = (tap_start + tap_end) / 2 % host->tap_num;
350 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET, tap_set);
352 /* Enable auto re-tuning */
353 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
354 SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN |
355 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
360 static bool renesas_sdhi_check_scc_error(struct tmio_mmc_host *host)
362 struct renesas_sdhi *priv = host_to_priv(host);
364 /* Check SCC error */
365 if (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL) &
366 SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &&
367 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ) &
368 SH_MOBILE_SDHI_SCC_RVSREQ_RVSERR) {
369 /* Clear SCC error */
370 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ, 0);
377 static void renesas_sdhi_hw_reset(struct tmio_mmc_host *host)
379 struct renesas_sdhi *priv;
381 priv = host_to_priv(host);
384 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
385 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
387 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL,
388 ~SH_MOBILE_SDHI_SCC_CKSEL_DTSEL &
389 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL));
391 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
392 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
394 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
395 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
396 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
398 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
399 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
400 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
403 static int renesas_sdhi_wait_idle(struct tmio_mmc_host *host, u32 bit)
406 /* CBSY is set when busy, SCLKDIVEN is cleared when busy */
407 u32 wait_state = (bit == TMIO_STAT_CMD_BUSY ? TMIO_STAT_CMD_BUSY : 0);
409 while (--timeout && (sd_ctrl_read16_and_16_as_32(host, CTL_STATUS)
410 & bit) == wait_state)
414 dev_warn(&host->pdev->dev, "timeout waiting for SD bus idle\n");
421 static int renesas_sdhi_write16_hook(struct tmio_mmc_host *host, int addr)
423 u32 bit = TMIO_STAT_SCLKDIVEN;
427 case CTL_STOP_INTERNAL_ACTION:
428 case CTL_XFER_BLK_COUNT:
429 case CTL_SD_XFER_LEN:
430 case CTL_SD_MEM_CARD_OPT:
431 case CTL_TRANSACTION_CTL:
434 if (host->pdata->flags & TMIO_MMC_HAVE_CBSY)
435 bit = TMIO_STAT_CMD_BUSY;
437 case CTL_SD_CARD_CLK_CTL:
438 return renesas_sdhi_wait_idle(host, bit);
444 static int renesas_sdhi_multi_io_quirk(struct mmc_card *card,
445 unsigned int direction, int blk_size)
448 * In Renesas controllers, when performing a
449 * multiple block read of one or two blocks,
450 * depending on the timing with which the
451 * response register is read, the response
452 * value may not be read properly.
453 * Use single block read for this HW bug
455 if ((direction == MMC_DATA_READ) &&
462 static void renesas_sdhi_enable_dma(struct tmio_mmc_host *host, bool enable)
464 /* Iff regs are 8 byte apart, sdbuf is 64 bit. Otherwise always 32. */
465 int width = (host->bus_shift == 2) ? 64 : 32;
467 sd_ctrl_write16(host, CTL_DMA_ENABLE, enable ? DMA_ENABLE_DMASDRW : 0);
468 renesas_sdhi_sdbuf_width(host, enable ? width : 16);
471 int renesas_sdhi_probe(struct platform_device *pdev,
472 const struct tmio_mmc_dma_ops *dma_ops)
474 struct tmio_mmc_data *mmd = pdev->dev.platform_data;
475 const struct renesas_sdhi_of_data *of_data;
476 struct tmio_mmc_data *mmc_data;
477 struct tmio_mmc_dma *dma_priv;
478 struct tmio_mmc_host *host;
479 struct renesas_sdhi *priv;
480 struct resource *res;
483 of_data = of_device_get_match_data(&pdev->dev);
485 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
489 priv = devm_kzalloc(&pdev->dev, sizeof(struct renesas_sdhi),
494 mmc_data = &priv->mmc_data;
495 dma_priv = &priv->dma_priv;
497 priv->clk = devm_clk_get(&pdev->dev, NULL);
498 if (IS_ERR(priv->clk)) {
499 ret = PTR_ERR(priv->clk);
500 dev_err(&pdev->dev, "cannot get clock: %d\n", ret);
505 * Some controllers provide a 2nd clock just to run the internal card
506 * detection logic. Unfortunately, the existing driver architecture does
507 * not support a separation of clocks for runtime PM usage. When
508 * native hotplug is used, the tmio driver assumes that the core
509 * must continue to run for card detect to stay active, so we cannot
511 * Additionally, it is prohibited to supply a clock to the core but not
512 * to the card detect circuit. That leaves us with if separate clocks
513 * are presented, we must treat them both as virtually 1 clock.
515 priv->clk_cd = devm_clk_get(&pdev->dev, "cd");
516 if (IS_ERR(priv->clk_cd))
519 priv->pinctrl = devm_pinctrl_get(&pdev->dev);
520 if (!IS_ERR(priv->pinctrl)) {
521 priv->pins_default = pinctrl_lookup_state(priv->pinctrl,
522 PINCTRL_STATE_DEFAULT);
523 priv->pins_uhs = pinctrl_lookup_state(priv->pinctrl,
527 host = tmio_mmc_host_alloc(pdev);
534 mmc_data->flags |= of_data->tmio_flags;
535 mmc_data->ocr_mask = of_data->tmio_ocr_mask;
536 mmc_data->capabilities |= of_data->capabilities;
537 mmc_data->capabilities2 |= of_data->capabilities2;
538 mmc_data->dma_rx_offset = of_data->dma_rx_offset;
539 mmc_data->max_blk_count = of_data->max_blk_count;
540 mmc_data->max_segs = of_data->max_segs;
541 dma_priv->dma_buswidth = of_data->dma_buswidth;
542 host->bus_shift = of_data->bus_shift;
545 host->dma = dma_priv;
546 host->write16_hook = renesas_sdhi_write16_hook;
547 host->clk_enable = renesas_sdhi_clk_enable;
548 host->clk_update = renesas_sdhi_clk_update;
549 host->clk_disable = renesas_sdhi_clk_disable;
550 host->multi_io_quirk = renesas_sdhi_multi_io_quirk;
552 /* SDR speeds are only available on Gen2+ */
553 if (mmc_data->flags & TMIO_MMC_MIN_RCAR2) {
554 /* card_busy caused issues on r8a73a4 (pre-Gen2) CD-less SDHI */
555 host->card_busy = renesas_sdhi_card_busy;
556 host->start_signal_voltage_switch =
557 renesas_sdhi_start_signal_voltage_switch;
560 /* Orginally registers were 16 bit apart, could be 32 or 64 nowadays */
561 if (!host->bus_shift && resource_size(res) > 0x100) /* old way to determine the shift */
567 dma_priv->filter = shdma_chan_filter;
568 dma_priv->enable = renesas_sdhi_enable_dma;
570 mmc_data->alignment_shift = 1; /* 2-byte alignment */
571 mmc_data->capabilities |= MMC_CAP_MMC_HIGHSPEED;
574 * All SDHI blocks support 2-byte and larger block sizes in 4-bit
577 mmc_data->flags |= TMIO_MMC_BLKSZ_2BYTES;
580 * All SDHI blocks support SDIO IRQ signalling.
582 mmc_data->flags |= TMIO_MMC_SDIO_IRQ;
584 /* All SDHI have CMD12 control bit */
585 mmc_data->flags |= TMIO_MMC_HAVE_CMD12_CTRL;
587 /* All SDHI have SDIO status bits which must be 1 */
588 mmc_data->flags |= TMIO_MMC_SDIO_STATUS_SETBITS;
590 ret = tmio_mmc_host_probe(host, mmc_data, dma_ops);
594 /* One Gen2 SDHI incarnation does NOT have a CBSY bit */
595 if (sd_ctrl_read16(host, CTL_VERSION) == SDHI_VER_GEN2_SDR50)
596 mmc_data->flags &= ~TMIO_MMC_HAVE_CBSY;
598 /* Enable tuning iff we have an SCC and a supported mode */
599 if (of_data && of_data->scc_offset &&
600 (host->mmc->caps & MMC_CAP_UHS_SDR104 ||
601 host->mmc->caps2 & MMC_CAP2_HS200_1_8V_SDR)) {
602 const struct renesas_sdhi_scc *taps = of_data->taps;
605 host->mmc->caps |= MMC_CAP_HW_RESET;
607 for (i = 0; i < of_data->taps_num; i++) {
608 if (taps[i].clk_rate == 0 ||
609 taps[i].clk_rate == host->mmc->f_max) {
610 host->scc_tappos = taps->tap;
617 dev_warn(&host->pdev->dev, "Unknown clock rate for SDR104\n");
619 priv->scc_ctl = host->ctl + of_data->scc_offset;
620 host->init_tuning = renesas_sdhi_init_tuning;
621 host->prepare_tuning = renesas_sdhi_prepare_tuning;
622 host->select_tuning = renesas_sdhi_select_tuning;
623 host->check_scc_error = renesas_sdhi_check_scc_error;
624 host->hw_reset = renesas_sdhi_hw_reset;
629 irq = platform_get_irq(pdev, i);
633 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq, 0,
634 dev_name(&pdev->dev), host);
639 /* There must be at least one IRQ source */
645 dev_info(&pdev->dev, "%s base at 0x%08lx max clock rate %u MHz\n",
646 mmc_hostname(host->mmc), (unsigned long)
647 (platform_get_resource(pdev, IORESOURCE_MEM, 0)->start),
648 host->mmc->f_max / 1000000);
653 tmio_mmc_host_remove(host);
655 tmio_mmc_host_free(host);
659 EXPORT_SYMBOL_GPL(renesas_sdhi_probe);
661 int renesas_sdhi_remove(struct platform_device *pdev)
663 struct mmc_host *mmc = platform_get_drvdata(pdev);
664 struct tmio_mmc_host *host = mmc_priv(mmc);
666 tmio_mmc_host_remove(host);
670 EXPORT_SYMBOL_GPL(renesas_sdhi_remove);
672 MODULE_LICENSE("GPL v2");