1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 2015-19 Renesas Electronics Corporation
6 * Copyright (C) 2016-19 Sang Engineering, Wolfram Sang
7 * Copyright (C) 2016-17 Horms Solutions, Simon Horman
8 * Copyright (C) 2009 Magnus Damm
10 * Based on "Compaq ASIC3 support":
12 * Copyright 2001 Compaq Computer Corporation.
13 * Copyright 2004-2005 Phil Blundell
14 * Copyright 2007-2008 OpenedHand Ltd.
21 #include <linux/clk.h>
22 #include <linux/delay.h>
23 #include <linux/iopoll.h>
24 #include <linux/kernel.h>
25 #include <linux/mfd/tmio.h>
26 #include <linux/mmc/host.h>
27 #include <linux/mmc/mmc.h>
28 #include <linux/mmc/slot-gpio.h>
29 #include <linux/module.h>
30 #include <linux/pinctrl/consumer.h>
31 #include <linux/pinctrl/pinctrl-state.h>
32 #include <linux/platform_device.h>
33 #include <linux/pm_domain.h>
34 #include <linux/regulator/consumer.h>
35 #include <linux/reset.h>
36 #include <linux/sh_dma.h>
37 #include <linux/slab.h>
39 #include "renesas_sdhi.h"
42 #define CTL_HOST_MODE 0xe4
43 #define HOST_MODE_GEN2_SDR50_WMODE BIT(0)
44 #define HOST_MODE_GEN2_SDR104_WMODE BIT(0)
45 #define HOST_MODE_GEN3_WMODE BIT(0)
46 #define HOST_MODE_GEN3_BUSWIDTH BIT(8)
48 #define HOST_MODE_GEN3_16BIT HOST_MODE_GEN3_WMODE
49 #define HOST_MODE_GEN3_32BIT (HOST_MODE_GEN3_WMODE | HOST_MODE_GEN3_BUSWIDTH)
50 #define HOST_MODE_GEN3_64BIT 0
52 #define SDHI_VER_GEN2_SDR50 0x490c
53 #define SDHI_VER_RZ_A1 0x820b
54 /* very old datasheets said 0x490c for SDR104, too. They are wrong! */
55 #define SDHI_VER_GEN2_SDR104 0xcb0d
56 #define SDHI_VER_GEN3_SD 0xcc10
57 #define SDHI_VER_GEN3_SDMMC 0xcd10
59 #define SDHI_GEN3_MMC0_ADDR 0xee140000
61 static void renesas_sdhi_sdbuf_width(struct tmio_mmc_host *host, int width)
67 * renesas_sdhi_of_data :: dma_buswidth
69 switch (sd_ctrl_read16(host, CTL_VERSION)) {
70 case SDHI_VER_GEN2_SDR50:
71 val = (width == 32) ? HOST_MODE_GEN2_SDR50_WMODE : 0;
73 case SDHI_VER_GEN2_SDR104:
74 val = (width == 32) ? 0 : HOST_MODE_GEN2_SDR104_WMODE;
76 case SDHI_VER_GEN3_SD:
77 case SDHI_VER_GEN3_SDMMC:
79 val = HOST_MODE_GEN3_64BIT;
81 val = HOST_MODE_GEN3_32BIT;
83 val = HOST_MODE_GEN3_16BIT;
90 sd_ctrl_write16(host, CTL_HOST_MODE, val);
93 static int renesas_sdhi_clk_enable(struct tmio_mmc_host *host)
95 struct mmc_host *mmc = host->mmc;
96 struct renesas_sdhi *priv = host_to_priv(host);
99 ret = clk_prepare_enable(priv->clk_cd);
104 * The clock driver may not know what maximum frequency
105 * actually works, so it should be set with the max-frequency
106 * property which will already have been read to f_max. If it
107 * was missing, assume the current frequency is the maximum.
110 mmc->f_max = clk_get_rate(priv->clk);
113 * Minimum frequency is the minimum input clock frequency
114 * divided by our maximum divider.
116 mmc->f_min = max(clk_round_rate(priv->clk, 1) / 512, 1L);
118 /* enable 16bit data access on SDBUF as default */
119 renesas_sdhi_sdbuf_width(host, 16);
124 static unsigned int renesas_sdhi_clk_update(struct tmio_mmc_host *host,
125 unsigned int wanted_clock)
127 struct renesas_sdhi *priv = host_to_priv(host);
128 struct clk *ref_clk = priv->clk;
129 unsigned int freq, diff, best_freq = 0, diff_min = ~0;
130 unsigned int new_clock, clkh_shift = 0;
131 unsigned int new_upper_limit;
135 * We simply return the current rate if a) we are not on a R-Car Gen2+
136 * SoC (may work for others, but untested) or b) if the SCC needs its
137 * clock during tuning, so we don't change the external clock setup.
139 if (!(host->pdata->flags & TMIO_MMC_MIN_RCAR2) || mmc_doing_tune(host->mmc))
140 return clk_get_rate(priv->clk);
143 /* HS400 with 4TAP needs different clock settings */
144 bool use_4tap = sdhi_has_quirk(priv, hs400_4taps);
145 bool need_slow_clkh = host->mmc->ios.timing == MMC_TIMING_MMC_HS400;
146 clkh_shift = use_4tap && need_slow_clkh ? 1 : 2;
147 ref_clk = priv->clkh;
150 new_clock = wanted_clock << clkh_shift;
153 * We want the bus clock to be as close as possible to, but no
154 * greater than, new_clock. As we can divide by 1 << i for
155 * any i in [0, 9] we want the input clock to be as close as
156 * possible, but no greater than, new_clock << i.
158 * Add an upper limit of 1/1024 rate higher to the clock rate to fix
159 * clk rate jumping to lower rate due to rounding error (eg: RZ/G2L has
160 * 3 clk sources 533.333333 MHz, 400 MHz and 266.666666 MHz. The request
161 * for 533.333333 MHz will selects a slower 400 MHz due to rounding
162 * error (533333333 Hz / 4 * 4 = 533333332 Hz < 533333333 Hz)).
164 for (i = min(9, ilog2(UINT_MAX / new_clock)); i >= 0; i--) {
165 freq = clk_round_rate(ref_clk, new_clock << i);
166 new_upper_limit = (new_clock << i) + ((new_clock << i) >> 10);
167 if (freq > new_upper_limit) {
168 /* Too fast; look for a slightly slower option */
169 freq = clk_round_rate(ref_clk, (new_clock << i) / 4 * 3);
170 if (freq > new_upper_limit)
174 diff = new_clock - (freq >> i);
175 if (diff <= diff_min) {
181 clk_set_rate(ref_clk, best_freq);
184 clk_set_rate(priv->clk, best_freq >> clkh_shift);
186 return clk_get_rate(priv->clk);
189 static void renesas_sdhi_set_clock(struct tmio_mmc_host *host,
190 unsigned int new_clock)
192 unsigned int clk_margin;
195 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
196 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
198 if (new_clock == 0) {
199 host->mmc->actual_clock = 0;
203 host->mmc->actual_clock = renesas_sdhi_clk_update(host, new_clock);
204 clock = host->mmc->actual_clock / 512;
207 * Add a margin of 1/1024 rate higher to the clock rate in order
208 * to avoid clk variable setting a value of 0 due to the margin
209 * provided for actual_clock in renesas_sdhi_clk_update().
211 clk_margin = new_clock >> 10;
212 for (clk = 0x80000080; new_clock + clk_margin >= (clock << 1); clk >>= 1)
215 /* 1/1 clock is option */
216 if ((host->pdata->flags & TMIO_MMC_CLK_ACTUAL) && ((clk >> 22) & 0x1)) {
217 if (!(host->mmc->ios.timing == MMC_TIMING_MMC_HS400))
223 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, clk & CLK_CTL_DIV_MASK);
224 if (!(host->pdata->flags & TMIO_MMC_MIN_RCAR2))
225 usleep_range(10000, 11000);
227 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
228 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
231 /* HW engineers overrode docs: no sleep needed on R-Car2+ */
232 if (!(host->pdata->flags & TMIO_MMC_MIN_RCAR2))
233 usleep_range(10000, 11000);
236 static void renesas_sdhi_clk_disable(struct tmio_mmc_host *host)
238 struct renesas_sdhi *priv = host_to_priv(host);
240 clk_disable_unprepare(priv->clk_cd);
243 static int renesas_sdhi_card_busy(struct mmc_host *mmc)
245 struct tmio_mmc_host *host = mmc_priv(mmc);
247 return !(sd_ctrl_read16_and_16_as_32(host, CTL_STATUS) &
251 static int renesas_sdhi_start_signal_voltage_switch(struct mmc_host *mmc,
254 struct tmio_mmc_host *host = mmc_priv(mmc);
255 struct renesas_sdhi *priv = host_to_priv(host);
256 struct pinctrl_state *pin_state;
259 switch (ios->signal_voltage) {
260 case MMC_SIGNAL_VOLTAGE_330:
261 pin_state = priv->pins_default;
263 case MMC_SIGNAL_VOLTAGE_180:
264 pin_state = priv->pins_uhs;
271 * If anything is missing, assume signal voltage is fixed at
272 * 3.3V and succeed/fail accordingly.
274 if (IS_ERR(priv->pinctrl) || IS_ERR(pin_state))
275 return ios->signal_voltage ==
276 MMC_SIGNAL_VOLTAGE_330 ? 0 : -EINVAL;
278 ret = mmc_regulator_set_vqmmc(host->mmc, ios);
282 return pinctrl_select_state(priv->pinctrl, pin_state);
286 #define SH_MOBILE_SDHI_SCC_DTCNTL 0x000
287 #define SH_MOBILE_SDHI_SCC_TAPSET 0x002
288 #define SH_MOBILE_SDHI_SCC_DT2FF 0x004
289 #define SH_MOBILE_SDHI_SCC_CKSEL 0x006
290 #define SH_MOBILE_SDHI_SCC_RVSCNTL 0x008
291 #define SH_MOBILE_SDHI_SCC_RVSREQ 0x00A
292 #define SH_MOBILE_SDHI_SCC_SMPCMP 0x00C
293 #define SH_MOBILE_SDHI_SCC_TMPPORT2 0x00E
294 #define SH_MOBILE_SDHI_SCC_TMPPORT3 0x014
295 #define SH_MOBILE_SDHI_SCC_TMPPORT4 0x016
296 #define SH_MOBILE_SDHI_SCC_TMPPORT5 0x018
297 #define SH_MOBILE_SDHI_SCC_TMPPORT6 0x01A
298 #define SH_MOBILE_SDHI_SCC_TMPPORT7 0x01C
300 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN BIT(0)
301 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT 16
302 #define SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_MASK 0xff
304 #define SH_MOBILE_SDHI_SCC_CKSEL_DTSEL BIT(0)
306 #define SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN BIT(0)
308 #define SH_MOBILE_SDHI_SCC_RVSREQ_REQTAPDOWN BIT(0)
309 #define SH_MOBILE_SDHI_SCC_RVSREQ_REQTAPUP BIT(1)
310 #define SH_MOBILE_SDHI_SCC_RVSREQ_RVSERR BIT(2)
312 #define SH_MOBILE_SDHI_SCC_SMPCMP_CMD_REQDOWN BIT(8)
313 #define SH_MOBILE_SDHI_SCC_SMPCMP_CMD_REQUP BIT(24)
314 #define SH_MOBILE_SDHI_SCC_SMPCMP_CMD_ERR (BIT(8) | BIT(24))
316 #define SH_MOBILE_SDHI_SCC_TMPPORT2_HS400OSEL BIT(4)
317 #define SH_MOBILE_SDHI_SCC_TMPPORT2_HS400EN BIT(31)
319 /* Definitions for values the SH_MOBILE_SDHI_SCC_TMPPORT4 register */
320 #define SH_MOBILE_SDHI_SCC_TMPPORT4_DLL_ACC_START BIT(0)
322 /* Definitions for values the SH_MOBILE_SDHI_SCC_TMPPORT5 register */
323 #define SH_MOBILE_SDHI_SCC_TMPPORT5_DLL_RW_SEL_R BIT(8)
324 #define SH_MOBILE_SDHI_SCC_TMPPORT5_DLL_RW_SEL_W (0 << 8)
325 #define SH_MOBILE_SDHI_SCC_TMPPORT5_DLL_ADR_MASK 0x3F
327 /* Definitions for values the SH_MOBILE_SDHI_SCC register */
328 #define SH_MOBILE_SDHI_SCC_TMPPORT_DISABLE_WP_CODE 0xa5000000
329 #define SH_MOBILE_SDHI_SCC_TMPPORT_CALIB_CODE_MASK 0x1f
330 #define SH_MOBILE_SDHI_SCC_TMPPORT_MANUAL_MODE BIT(7)
332 static inline u32 sd_scc_read32(struct tmio_mmc_host *host,
333 struct renesas_sdhi *priv, int addr)
335 return readl(priv->scc_ctl + (addr << host->bus_shift));
338 static inline void sd_scc_write32(struct tmio_mmc_host *host,
339 struct renesas_sdhi *priv,
342 writel(val, priv->scc_ctl + (addr << host->bus_shift));
345 static unsigned int renesas_sdhi_init_tuning(struct tmio_mmc_host *host)
347 struct renesas_sdhi *priv;
349 priv = host_to_priv(host);
352 sd_ctrl_write32_as_16_and_16(host, CTL_STATUS, 0x0);
354 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
355 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
357 /* set sampling clock selection range */
358 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL,
359 SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN |
360 0x8 << SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT);
362 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL,
363 SH_MOBILE_SDHI_SCC_CKSEL_DTSEL |
364 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL));
366 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
367 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
368 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
370 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DT2FF, priv->scc_tappos);
372 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
373 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
376 return (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL) >>
377 SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_SHIFT) &
378 SH_MOBILE_SDHI_SCC_DTCNTL_TAPNUM_MASK;
381 static void renesas_sdhi_hs400_complete(struct mmc_host *mmc)
383 struct tmio_mmc_host *host = mmc_priv(mmc);
384 struct renesas_sdhi *priv = host_to_priv(host);
385 u32 bad_taps = priv->quirks ? priv->quirks->hs400_bad_taps : 0;
386 bool use_4tap = sdhi_has_quirk(priv, hs400_4taps);
388 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
389 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
392 sd_ctrl_write16(host, CTL_SDIF_MODE, SDIF_MODE_HS400 |
393 sd_ctrl_read16(host, CTL_SDIF_MODE));
395 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DT2FF,
396 priv->scc_tappos_hs400);
398 if (sdhi_has_quirk(priv, manual_tap_correction))
399 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
400 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
401 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
403 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT2,
404 (SH_MOBILE_SDHI_SCC_TMPPORT2_HS400EN |
405 SH_MOBILE_SDHI_SCC_TMPPORT2_HS400OSEL) |
406 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT2));
408 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL,
409 SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN |
410 sd_scc_read32(host, priv,
411 SH_MOBILE_SDHI_SCC_DTCNTL));
414 if (bad_taps & BIT(priv->tap_set)) {
415 u32 new_tap = (priv->tap_set + 1) % priv->tap_num;
417 if (bad_taps & BIT(new_tap))
418 new_tap = (priv->tap_set - 1) % priv->tap_num;
420 if (bad_taps & BIT(new_tap)) {
421 new_tap = priv->tap_set;
422 dev_dbg(&host->pdev->dev, "Can't handle three bad tap in a row\n");
425 priv->tap_set = new_tap;
428 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET,
429 priv->tap_set / (use_4tap ? 2 : 1));
431 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL,
432 SH_MOBILE_SDHI_SCC_CKSEL_DTSEL |
433 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL));
435 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
436 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
438 if (priv->adjust_hs400_calib_table)
439 priv->needs_adjust_hs400 = true;
442 static void renesas_sdhi_disable_scc(struct mmc_host *mmc)
444 struct tmio_mmc_host *host = mmc_priv(mmc);
445 struct renesas_sdhi *priv = host_to_priv(host);
447 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
448 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
450 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_CKSEL,
451 ~SH_MOBILE_SDHI_SCC_CKSEL_DTSEL &
452 sd_scc_read32(host, priv,
453 SH_MOBILE_SDHI_SCC_CKSEL));
455 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DTCNTL,
456 ~SH_MOBILE_SDHI_SCC_DTCNTL_TAPEN &
457 sd_scc_read32(host, priv,
458 SH_MOBILE_SDHI_SCC_DTCNTL));
460 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
461 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
464 static u32 sd_scc_tmpport_read32(struct tmio_mmc_host *host,
465 struct renesas_sdhi *priv, u32 addr)
468 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT5,
469 SH_MOBILE_SDHI_SCC_TMPPORT5_DLL_RW_SEL_R |
470 (SH_MOBILE_SDHI_SCC_TMPPORT5_DLL_ADR_MASK & addr));
472 /* access start and stop */
473 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT4,
474 SH_MOBILE_SDHI_SCC_TMPPORT4_DLL_ACC_START);
475 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT4, 0);
477 return sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT7);
480 static void sd_scc_tmpport_write32(struct tmio_mmc_host *host,
481 struct renesas_sdhi *priv, u32 addr, u32 val)
484 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT5,
485 SH_MOBILE_SDHI_SCC_TMPPORT5_DLL_RW_SEL_W |
486 (SH_MOBILE_SDHI_SCC_TMPPORT5_DLL_ADR_MASK & addr));
488 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT6, val);
490 /* access start and stop */
491 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT4,
492 SH_MOBILE_SDHI_SCC_TMPPORT4_DLL_ACC_START);
493 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT4, 0);
496 static void renesas_sdhi_adjust_hs400_mode_enable(struct tmio_mmc_host *host)
498 struct renesas_sdhi *priv = host_to_priv(host);
501 /* disable write protect */
502 sd_scc_tmpport_write32(host, priv, 0x00,
503 SH_MOBILE_SDHI_SCC_TMPPORT_DISABLE_WP_CODE);
504 /* read calibration code and adjust */
505 calib_code = sd_scc_tmpport_read32(host, priv, 0x26);
506 calib_code &= SH_MOBILE_SDHI_SCC_TMPPORT_CALIB_CODE_MASK;
508 sd_scc_tmpport_write32(host, priv, 0x22,
509 SH_MOBILE_SDHI_SCC_TMPPORT_MANUAL_MODE |
510 priv->adjust_hs400_calib_table[calib_code]);
512 /* set offset value to TMPPORT3, hardcoded to OFFSET0 (= 0x3) for now */
513 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT3, 0x3);
515 /* adjustment done, clear flag */
516 priv->needs_adjust_hs400 = false;
519 static void renesas_sdhi_adjust_hs400_mode_disable(struct tmio_mmc_host *host)
521 struct renesas_sdhi *priv = host_to_priv(host);
523 /* disable write protect */
524 sd_scc_tmpport_write32(host, priv, 0x00,
525 SH_MOBILE_SDHI_SCC_TMPPORT_DISABLE_WP_CODE);
526 /* disable manual calibration */
527 sd_scc_tmpport_write32(host, priv, 0x22, 0);
528 /* clear offset value of TMPPORT3 */
529 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT3, 0);
532 static void renesas_sdhi_reset_hs400_mode(struct tmio_mmc_host *host,
533 struct renesas_sdhi *priv)
535 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, ~CLK_CTL_SCLKEN &
536 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
538 /* Reset HS400 mode */
539 sd_ctrl_write16(host, CTL_SDIF_MODE, ~SDIF_MODE_HS400 &
540 sd_ctrl_read16(host, CTL_SDIF_MODE));
542 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_DT2FF, priv->scc_tappos);
544 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT2,
545 ~(SH_MOBILE_SDHI_SCC_TMPPORT2_HS400EN |
546 SH_MOBILE_SDHI_SCC_TMPPORT2_HS400OSEL) &
547 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_TMPPORT2));
549 if (sdhi_has_quirk(priv, hs400_calib_table) || sdhi_has_quirk(priv, hs400_bad_taps))
550 renesas_sdhi_adjust_hs400_mode_disable(host);
552 sd_ctrl_write16(host, CTL_SD_CARD_CLK_CTL, CLK_CTL_SCLKEN |
553 sd_ctrl_read16(host, CTL_SD_CARD_CLK_CTL));
556 static int renesas_sdhi_prepare_hs400_tuning(struct mmc_host *mmc, struct mmc_ios *ios)
558 struct tmio_mmc_host *host = mmc_priv(mmc);
560 renesas_sdhi_reset_hs400_mode(host, host_to_priv(host));
564 static void renesas_sdhi_scc_reset(struct tmio_mmc_host *host, struct renesas_sdhi *priv)
566 renesas_sdhi_disable_scc(host->mmc);
567 renesas_sdhi_reset_hs400_mode(host, priv);
568 priv->needs_adjust_hs400 = false;
570 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
571 ~SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN &
572 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
575 /* only populated for TMIO_MMC_MIN_RCAR2 */
576 static void renesas_sdhi_reset(struct tmio_mmc_host *host, bool preserve)
578 struct renesas_sdhi *priv = host_to_priv(host);
584 reset_control_reset(priv->rstc);
585 /* Unknown why but without polling reset status, it will hang */
586 read_poll_timeout(reset_control_status, ret, ret == 0, 1, 100,
588 /* At least SDHI_VER_GEN2_SDR50 needs manual release of reset */
589 sd_ctrl_write16(host, CTL_RESET_SD, 0x0001);
590 priv->needs_adjust_hs400 = false;
591 renesas_sdhi_set_clock(host, host->clk_cache);
592 } else if (priv->scc_ctl) {
593 renesas_sdhi_scc_reset(host, priv);
597 if (sd_ctrl_read16(host, CTL_VERSION) >= SDHI_VER_GEN3_SD) {
598 val = sd_ctrl_read16(host, CTL_SD_MEM_CARD_OPT);
599 val |= CARD_OPT_EXTOP;
600 sd_ctrl_write16(host, CTL_SD_MEM_CARD_OPT, val);
604 static unsigned int renesas_sdhi_gen3_get_cycles(struct tmio_mmc_host *host)
606 u16 num, val = sd_ctrl_read16(host, CTL_SD_MEM_CARD_OPT);
608 num = (val & CARD_OPT_TOP_MASK) >> CARD_OPT_TOP_SHIFT;
609 return 1 << ((val & CARD_OPT_EXTOP ? 14 : 13) + num);
613 #define SH_MOBILE_SDHI_MIN_TAP_ROW 3
615 static int renesas_sdhi_select_tuning(struct tmio_mmc_host *host)
617 struct renesas_sdhi *priv = host_to_priv(host);
618 unsigned int tap_start = 0, tap_end = 0, tap_cnt = 0, rs, re, i;
619 unsigned int taps_size = priv->tap_num * 2, min_tap_row;
620 unsigned long *bitmap;
622 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ, 0);
625 * When tuning CMD19 is issued twice for each tap, merge the
626 * result requiring the tap to be good in both runs before
627 * considering it for tuning selection.
629 for (i = 0; i < taps_size; i++) {
630 int offset = priv->tap_num * (i < priv->tap_num ? 1 : -1);
632 if (!test_bit(i, priv->taps))
633 clear_bit(i + offset, priv->taps);
635 if (!test_bit(i, priv->smpcmp))
636 clear_bit(i + offset, priv->smpcmp);
640 * If all TAP are OK, the sampling clock position is selected by
641 * identifying the change point of data.
643 if (bitmap_full(priv->taps, taps_size)) {
644 bitmap = priv->smpcmp;
648 min_tap_row = SH_MOBILE_SDHI_MIN_TAP_ROW;
652 * Find the longest consecutive run of successful probes. If that
653 * is at least SH_MOBILE_SDHI_MIN_TAP_ROW probes long then use the
654 * center index as the tap, otherwise bail out.
656 for_each_set_bitrange(rs, re, bitmap, taps_size) {
657 if (re - rs > tap_cnt) {
660 tap_cnt = tap_end - tap_start;
664 if (tap_cnt >= min_tap_row)
665 priv->tap_set = (tap_start + tap_end) / 2 % priv->tap_num;
670 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET, priv->tap_set);
672 /* Enable auto re-tuning */
673 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL,
674 SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN |
675 sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL));
680 static int renesas_sdhi_execute_tuning(struct mmc_host *mmc, u32 opcode)
682 struct tmio_mmc_host *host = mmc_priv(mmc);
683 struct renesas_sdhi *priv = host_to_priv(host);
686 priv->tap_num = renesas_sdhi_init_tuning(host);
688 return 0; /* Tuning is not supported */
690 if (priv->tap_num * 2 >= sizeof(priv->taps) * BITS_PER_BYTE) {
691 dev_err(&host->pdev->dev,
692 "Too many taps, please update 'taps' in tmio_mmc_host!\n");
696 bitmap_zero(priv->taps, priv->tap_num * 2);
697 bitmap_zero(priv->smpcmp, priv->tap_num * 2);
699 /* Issue CMD19 twice for each tap */
700 for (i = 0; i < 2 * priv->tap_num; i++) {
703 /* Set sampling clock position */
704 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET, i % priv->tap_num);
706 if (mmc_send_tuning(mmc, opcode, &cmd_error) == 0)
707 set_bit(i, priv->taps);
709 if (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_SMPCMP) == 0)
710 set_bit(i, priv->smpcmp);
713 mmc_send_abort_tuning(mmc, opcode);
716 ret = renesas_sdhi_select_tuning(host);
718 renesas_sdhi_scc_reset(host, priv);
722 static bool renesas_sdhi_manual_correction(struct tmio_mmc_host *host, bool use_4tap)
724 struct renesas_sdhi *priv = host_to_priv(host);
725 unsigned int new_tap = priv->tap_set, error_tap = priv->tap_set;
728 val = sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ);
732 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ, 0);
734 /* Change TAP position according to correction status */
735 if (sdhi_has_quirk(priv, manual_tap_correction) &&
736 host->mmc->ios.timing == MMC_TIMING_MMC_HS400) {
737 u32 bad_taps = priv->quirks ? priv->quirks->hs400_bad_taps : 0;
739 * With HS400, the DAT signal is based on DS, not CLK.
740 * Therefore, use only CMD status.
742 u32 smpcmp = sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_SMPCMP) &
743 SH_MOBILE_SDHI_SCC_SMPCMP_CMD_ERR;
745 return false; /* no error in CMD signal */
746 } else if (smpcmp == SH_MOBILE_SDHI_SCC_SMPCMP_CMD_REQUP) {
749 } else if (smpcmp == SH_MOBILE_SDHI_SCC_SMPCMP_CMD_REQDOWN) {
753 return true; /* need retune */
757 * When new_tap is a bad tap, we cannot change. Then, we compare
758 * with the HS200 tuning result. When smpcmp[error_tap] is OK,
759 * we can at least retune.
761 if (bad_taps & BIT(new_tap % priv->tap_num))
762 return test_bit(error_tap % priv->tap_num, priv->smpcmp);
764 if (val & SH_MOBILE_SDHI_SCC_RVSREQ_RVSERR)
765 return true; /* need retune */
766 else if (val & SH_MOBILE_SDHI_SCC_RVSREQ_REQTAPUP)
768 else if (val & SH_MOBILE_SDHI_SCC_RVSREQ_REQTAPDOWN)
774 priv->tap_set = (new_tap % priv->tap_num);
775 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_TAPSET,
776 priv->tap_set / (use_4tap ? 2 : 1));
781 static bool renesas_sdhi_auto_correction(struct tmio_mmc_host *host)
783 struct renesas_sdhi *priv = host_to_priv(host);
785 /* Check SCC error */
786 if (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ) &
787 SH_MOBILE_SDHI_SCC_RVSREQ_RVSERR) {
788 sd_scc_write32(host, priv, SH_MOBILE_SDHI_SCC_RVSREQ, 0);
795 static bool renesas_sdhi_check_scc_error(struct tmio_mmc_host *host,
796 struct mmc_request *mrq)
798 struct renesas_sdhi *priv = host_to_priv(host);
799 bool use_4tap = sdhi_has_quirk(priv, hs400_4taps);
803 * Skip checking SCC errors when running on 4 taps in HS400 mode as
804 * any retuning would still result in the same 4 taps being used.
806 if (!(host->mmc->ios.timing == MMC_TIMING_UHS_SDR104) &&
807 !(host->mmc->ios.timing == MMC_TIMING_MMC_HS200) &&
808 !(host->mmc->ios.timing == MMC_TIMING_MMC_HS400 && !use_4tap))
811 if (mmc_doing_tune(host->mmc))
814 if (((mrq->cmd->error == -ETIMEDOUT) ||
815 (mrq->data && mrq->data->error == -ETIMEDOUT)) &&
816 ((host->mmc->caps & MMC_CAP_NONREMOVABLE) ||
817 (host->ops.get_cd && host->ops.get_cd(host->mmc))))
820 if (sd_scc_read32(host, priv, SH_MOBILE_SDHI_SCC_RVSCNTL) &
821 SH_MOBILE_SDHI_SCC_RVSCNTL_RVSEN)
822 ret |= renesas_sdhi_auto_correction(host);
824 ret |= renesas_sdhi_manual_correction(host, use_4tap);
829 static int renesas_sdhi_wait_idle(struct tmio_mmc_host *host, u32 bit)
832 /* CBSY is set when busy, SCLKDIVEN is cleared when busy */
833 u32 wait_state = (bit == TMIO_STAT_CMD_BUSY ? TMIO_STAT_CMD_BUSY : 0);
835 while (--timeout && (sd_ctrl_read16_and_16_as_32(host, CTL_STATUS)
836 & bit) == wait_state)
840 dev_warn(&host->pdev->dev, "timeout waiting for SD bus idle\n");
847 static int renesas_sdhi_write16_hook(struct tmio_mmc_host *host, int addr)
849 u32 bit = TMIO_STAT_SCLKDIVEN;
853 case CTL_STOP_INTERNAL_ACTION:
854 case CTL_XFER_BLK_COUNT:
855 case CTL_SD_XFER_LEN:
856 case CTL_SD_MEM_CARD_OPT:
857 case CTL_TRANSACTION_CTL:
860 if (host->pdata->flags & TMIO_MMC_HAVE_CBSY)
861 bit = TMIO_STAT_CMD_BUSY;
863 case CTL_SD_CARD_CLK_CTL:
864 return renesas_sdhi_wait_idle(host, bit);
870 static int renesas_sdhi_multi_io_quirk(struct mmc_card *card,
871 unsigned int direction, int blk_size)
874 * In Renesas controllers, when performing a
875 * multiple block read of one or two blocks,
876 * depending on the timing with which the
877 * response register is read, the response
878 * value may not be read properly.
879 * Use single block read for this HW bug
881 if ((direction == MMC_DATA_READ) &&
888 static void renesas_sdhi_fixup_request(struct tmio_mmc_host *host, struct mmc_request *mrq)
890 struct renesas_sdhi *priv = host_to_priv(host);
892 if (priv->needs_adjust_hs400 && mrq->cmd->opcode == MMC_SEND_STATUS)
893 renesas_sdhi_adjust_hs400_mode_enable(host);
895 static void renesas_sdhi_enable_dma(struct tmio_mmc_host *host, bool enable)
897 /* Iff regs are 8 byte apart, sdbuf is 64 bit. Otherwise always 32. */
898 int width = (host->bus_shift == 2) ? 64 : 32;
900 sd_ctrl_write16(host, CTL_DMA_ENABLE, enable ? DMA_ENABLE_DMASDRW : 0);
901 renesas_sdhi_sdbuf_width(host, enable ? width : 16);
904 int renesas_sdhi_probe(struct platform_device *pdev,
905 const struct tmio_mmc_dma_ops *dma_ops,
906 const struct renesas_sdhi_of_data *of_data,
907 const struct renesas_sdhi_quirks *quirks)
909 struct tmio_mmc_data *mmd = pdev->dev.platform_data;
910 struct tmio_mmc_data *mmc_data;
911 struct renesas_sdhi_dma *dma_priv;
912 struct tmio_mmc_host *host;
913 struct renesas_sdhi *priv;
914 int num_irqs, irq, ret, i;
915 struct resource *res;
918 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
922 priv = devm_kzalloc(&pdev->dev, sizeof(struct renesas_sdhi),
927 priv->quirks = quirks;
928 mmc_data = &priv->mmc_data;
929 dma_priv = &priv->dma_priv;
931 priv->clk = devm_clk_get(&pdev->dev, NULL);
932 if (IS_ERR(priv->clk))
933 return dev_err_probe(&pdev->dev, PTR_ERR(priv->clk), "cannot get clock");
935 priv->clkh = devm_clk_get_optional(&pdev->dev, "clkh");
936 if (IS_ERR(priv->clkh))
937 return dev_err_probe(&pdev->dev, PTR_ERR(priv->clkh), "cannot get clkh");
940 * Some controllers provide a 2nd clock just to run the internal card
941 * detection logic. Unfortunately, the existing driver architecture does
942 * not support a separation of clocks for runtime PM usage. When
943 * native hotplug is used, the tmio driver assumes that the core
944 * must continue to run for card detect to stay active, so we cannot
946 * Additionally, it is prohibited to supply a clock to the core but not
947 * to the card detect circuit. That leaves us with if separate clocks
948 * are presented, we must treat them both as virtually 1 clock.
950 priv->clk_cd = devm_clk_get_optional(&pdev->dev, "cd");
951 if (IS_ERR(priv->clk_cd))
952 return dev_err_probe(&pdev->dev, PTR_ERR(priv->clk_cd), "cannot get cd clock");
954 priv->rstc = devm_reset_control_get_optional_exclusive(&pdev->dev, NULL);
955 if (IS_ERR(priv->rstc))
956 return PTR_ERR(priv->rstc);
958 priv->pinctrl = devm_pinctrl_get(&pdev->dev);
959 if (!IS_ERR(priv->pinctrl)) {
960 priv->pins_default = pinctrl_lookup_state(priv->pinctrl,
961 PINCTRL_STATE_DEFAULT);
962 priv->pins_uhs = pinctrl_lookup_state(priv->pinctrl,
966 host = tmio_mmc_host_alloc(pdev, mmc_data);
968 return PTR_ERR(host);
971 mmc_data->flags |= of_data->tmio_flags;
972 mmc_data->ocr_mask = of_data->tmio_ocr_mask;
973 mmc_data->capabilities |= of_data->capabilities;
974 mmc_data->capabilities2 |= of_data->capabilities2;
975 mmc_data->dma_rx_offset = of_data->dma_rx_offset;
976 mmc_data->max_blk_count = of_data->max_blk_count;
977 mmc_data->max_segs = of_data->max_segs;
978 dma_priv->dma_buswidth = of_data->dma_buswidth;
979 host->bus_shift = of_data->bus_shift;
980 /* Fallback for old DTs */
981 if (!priv->clkh && of_data->sdhi_flags & SDHI_FLAG_NEED_CLKH_FALLBACK)
982 priv->clkh = clk_get_parent(clk_get_parent(priv->clk));
986 host->write16_hook = renesas_sdhi_write16_hook;
987 host->clk_enable = renesas_sdhi_clk_enable;
988 host->clk_disable = renesas_sdhi_clk_disable;
989 host->set_clock = renesas_sdhi_set_clock;
990 host->multi_io_quirk = renesas_sdhi_multi_io_quirk;
991 host->dma_ops = dma_ops;
993 if (sdhi_has_quirk(priv, hs400_disabled))
994 host->mmc->caps2 &= ~(MMC_CAP2_HS400 | MMC_CAP2_HS400_ES);
996 /* For some SoC, we disable internal WP. GPIO may override this */
997 if (mmc_can_gpio_ro(host->mmc))
998 mmc_data->capabilities2 &= ~MMC_CAP2_NO_WRITE_PROTECT;
1000 /* SDR speeds are only available on Gen2+ */
1001 if (mmc_data->flags & TMIO_MMC_MIN_RCAR2) {
1002 /* card_busy caused issues on r8a73a4 (pre-Gen2) CD-less SDHI */
1003 host->ops.card_busy = renesas_sdhi_card_busy;
1004 host->ops.start_signal_voltage_switch =
1005 renesas_sdhi_start_signal_voltage_switch;
1006 host->sdcard_irq_setbit_mask = TMIO_STAT_ALWAYS_SET_27;
1007 host->sdcard_irq_mask_all = TMIO_MASK_ALL_RCAR2;
1008 host->reset = renesas_sdhi_reset;
1011 /* Orginally registers were 16 bit apart, could be 32 or 64 nowadays */
1012 if (!host->bus_shift && resource_size(res) > 0x100) /* old way to determine the shift */
1013 host->bus_shift = 1;
1018 dma_priv->filter = shdma_chan_filter;
1019 dma_priv->enable = renesas_sdhi_enable_dma;
1021 mmc_data->capabilities |= MMC_CAP_MMC_HIGHSPEED;
1024 * All SDHI blocks support 2-byte and larger block sizes in 4-bit
1027 mmc_data->flags |= TMIO_MMC_BLKSZ_2BYTES;
1030 * All SDHI blocks support SDIO IRQ signalling.
1032 mmc_data->flags |= TMIO_MMC_SDIO_IRQ;
1034 /* All SDHI have CMD12 control bit */
1035 mmc_data->flags |= TMIO_MMC_HAVE_CMD12_CTRL;
1037 /* All SDHI have SDIO status bits which must be 1 */
1038 mmc_data->flags |= TMIO_MMC_SDIO_STATUS_SETBITS;
1040 /* All SDHI support HW busy detection */
1041 mmc_data->flags |= TMIO_MMC_USE_BUSY_TIMEOUT;
1043 dev_pm_domain_start(&pdev->dev);
1045 ret = renesas_sdhi_clk_enable(host);
1049 ver = sd_ctrl_read16(host, CTL_VERSION);
1050 /* GEN2_SDR104 is first known SDHI to use 32bit block count */
1051 if (ver < SDHI_VER_GEN2_SDR104 && mmc_data->max_blk_count > U16_MAX)
1052 mmc_data->max_blk_count = U16_MAX;
1054 /* One Gen2 SDHI incarnation does NOT have a CBSY bit */
1055 if (ver == SDHI_VER_GEN2_SDR50)
1056 mmc_data->flags &= ~TMIO_MMC_HAVE_CBSY;
1058 if (ver == SDHI_VER_GEN3_SDMMC && sdhi_has_quirk(priv, hs400_calib_table)) {
1059 host->fixup_request = renesas_sdhi_fixup_request;
1060 priv->adjust_hs400_calib_table = *(
1061 res->start == SDHI_GEN3_MMC0_ADDR ?
1062 quirks->hs400_calib_table :
1063 quirks->hs400_calib_table + 1);
1066 /* these have an EXTOP bit */
1067 if (ver >= SDHI_VER_GEN3_SD)
1068 host->get_timeout_cycles = renesas_sdhi_gen3_get_cycles;
1070 /* Check for SCC so we can reset it if needed */
1071 if (of_data && of_data->scc_offset && ver >= SDHI_VER_GEN2_SDR104)
1072 priv->scc_ctl = host->ctl + of_data->scc_offset;
1074 /* Enable tuning iff we have an SCC and a supported mode */
1075 if (priv->scc_ctl && (host->mmc->caps & MMC_CAP_UHS_SDR104 ||
1076 host->mmc->caps2 & MMC_CAP2_HSX00_1_8V)) {
1077 const struct renesas_sdhi_scc *taps = of_data->taps;
1078 bool use_4tap = sdhi_has_quirk(priv, hs400_4taps);
1081 for (i = 0; i < of_data->taps_num; i++) {
1082 if (taps[i].clk_rate == 0 ||
1083 taps[i].clk_rate == host->mmc->f_max) {
1084 priv->scc_tappos = taps->tap;
1085 priv->scc_tappos_hs400 = use_4tap ?
1086 taps->tap_hs400_4tap :
1094 dev_warn(&host->pdev->dev, "Unknown clock rate for tuning\n");
1096 host->check_retune = renesas_sdhi_check_scc_error;
1097 host->ops.execute_tuning = renesas_sdhi_execute_tuning;
1098 host->ops.prepare_hs400_tuning = renesas_sdhi_prepare_hs400_tuning;
1099 host->ops.hs400_downgrade = renesas_sdhi_disable_scc;
1100 host->ops.hs400_complete = renesas_sdhi_hs400_complete;
1103 ret = tmio_mmc_host_probe(host);
1107 num_irqs = platform_irq_count(pdev);
1113 /* There must be at least one IRQ source */
1119 for (i = 0; i < num_irqs; i++) {
1120 irq = platform_get_irq(pdev, i);
1126 ret = devm_request_irq(&pdev->dev, irq, tmio_mmc_irq, 0,
1127 dev_name(&pdev->dev), host);
1132 dev_info(&pdev->dev, "%s base at %pa, max clock rate %u MHz\n",
1133 mmc_hostname(host->mmc), &res->start, host->mmc->f_max / 1000000);
1138 tmio_mmc_host_remove(host);
1140 renesas_sdhi_clk_disable(host);
1142 tmio_mmc_host_free(host);
1146 EXPORT_SYMBOL_GPL(renesas_sdhi_probe);
1148 int renesas_sdhi_remove(struct platform_device *pdev)
1150 struct tmio_mmc_host *host = platform_get_drvdata(pdev);
1152 tmio_mmc_host_remove(host);
1153 renesas_sdhi_clk_disable(host);
1154 tmio_mmc_host_free(host);
1158 EXPORT_SYMBOL_GPL(renesas_sdhi_remove);
1160 MODULE_LICENSE("GPL v2");