xref: /openbmc/linux/drivers/mmc/host/sdhci-sprd.c (revision 7f1005dd)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Secure Digital Host Controller
4 //
5 // Copyright (C) 2018 Spreadtrum, Inc.
6 // Author: Chunyan Zhang <chunyan.zhang@unisoc.com>
7 
8 #include <linux/delay.h>
9 #include <linux/dma-mapping.h>
10 #include <linux/highmem.h>
11 #include <linux/iopoll.h>
12 #include <linux/mmc/host.h>
13 #include <linux/mmc/mmc.h>
14 #include <linux/module.h>
15 #include <linux/of.h>
16 #include <linux/of_gpio.h>
17 #include <linux/pinctrl/consumer.h>
18 #include <linux/platform_device.h>
19 #include <linux/pm_runtime.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/slab.h>
22 
23 #include "sdhci-pltfm.h"
24 #include "mmc_hsq.h"
25 
26 /* SDHCI_ARGUMENT2 register high 16bit */
27 #define SDHCI_SPRD_ARG2_STUFF		GENMASK(31, 16)
28 
29 #define SDHCI_SPRD_REG_32_DLL_CFG	0x200
30 #define  SDHCI_SPRD_DLL_ALL_CPST_EN	(BIT(18) | BIT(24) | BIT(25) | BIT(26) | BIT(27))
31 #define  SDHCI_SPRD_DLL_EN		BIT(21)
32 #define  SDHCI_SPRD_DLL_SEARCH_MODE	BIT(16)
33 #define  SDHCI_SPRD_DLL_INIT_COUNT	0xc00
34 #define  SDHCI_SPRD_DLL_PHASE_INTERNAL	0x3
35 
36 #define SDHCI_SPRD_REG_32_DLL_DLY	0x204
37 
38 #define SDHCI_SPRD_REG_32_DLL_DLY_OFFSET	0x208
39 #define  SDHCIBSPRD_IT_WR_DLY_INV		BIT(5)
40 #define  SDHCI_SPRD_BIT_CMD_DLY_INV		BIT(13)
41 #define  SDHCI_SPRD_BIT_POSRD_DLY_INV		BIT(21)
42 #define  SDHCI_SPRD_BIT_NEGRD_DLY_INV		BIT(29)
43 
44 #define SDHCI_SPRD_REG_32_DLL_STS0	0x210
45 #define SDHCI_SPRD_DLL_LOCKED		BIT(18)
46 
47 #define SDHCI_SPRD_REG_32_BUSY_POSI		0x250
48 #define  SDHCI_SPRD_BIT_OUTR_CLK_AUTO_EN	BIT(25)
49 #define  SDHCI_SPRD_BIT_INNR_CLK_AUTO_EN	BIT(24)
50 
51 #define SDHCI_SPRD_REG_DEBOUNCE		0x28C
52 #define  SDHCI_SPRD_BIT_DLL_BAK		BIT(0)
53 #define  SDHCI_SPRD_BIT_DLL_VAL		BIT(1)
54 
55 #define  SDHCI_SPRD_INT_SIGNAL_MASK	0x1B7F410B
56 
57 /* SDHCI_HOST_CONTROL2 */
58 #define  SDHCI_SPRD_CTRL_HS200		0x0005
59 #define  SDHCI_SPRD_CTRL_HS400		0x0006
60 #define  SDHCI_SPRD_CTRL_HS400ES	0x0007
61 
62 /*
63  * According to the standard specification, BIT(3) of SDHCI_SOFTWARE_RESET is
64  * reserved, and only used on Spreadtrum's design, the hardware cannot work
65  * if this bit is cleared.
66  * 1 : normal work
67  * 0 : hardware reset
68  */
69 #define  SDHCI_HW_RESET_CARD		BIT(3)
70 
71 #define SDHCI_SPRD_MAX_CUR		0xFFFFFF
72 #define SDHCI_SPRD_CLK_MAX_DIV		1023
73 
74 #define SDHCI_SPRD_CLK_DEF_RATE		26000000
75 #define SDHCI_SPRD_PHY_DLL_CLK		52000000
76 
77 #define SDHCI_SPRD_MAX_RANGE		0xff
78 #define SDHCI_SPRD_CMD_DLY_MASK		GENMASK(15, 8)
79 #define SDHCI_SPRD_POSRD_DLY_MASK	GENMASK(23, 16)
80 #define SDHCI_SPRD_CPST_EN		GENMASK(27, 24)
81 
82 struct sdhci_sprd_host {
83 	u32 version;
84 	struct clk *clk_sdio;
85 	struct clk *clk_enable;
86 	struct clk *clk_2x_enable;
87 	struct pinctrl *pinctrl;
88 	struct pinctrl_state *pins_uhs;
89 	struct pinctrl_state *pins_default;
90 	u32 base_rate;
91 	int flags; /* backup of host attribute */
92 	u32 phy_delay[MMC_TIMING_MMC_HS400 + 2];
93 };
94 
95 enum sdhci_sprd_tuning_type {
96 	SDHCI_SPRD_TUNING_SD_HS_CMD,
97 	SDHCI_SPRD_TUNING_SD_HS_DATA,
98 };
99 
100 struct sdhci_sprd_phy_cfg {
101 	const char *property;
102 	u8 timing;
103 };
104 
105 static const struct sdhci_sprd_phy_cfg sdhci_sprd_phy_cfgs[] = {
106 	{ "sprd,phy-delay-legacy", MMC_TIMING_LEGACY, },
107 	{ "sprd,phy-delay-sd-highspeed", MMC_TIMING_SD_HS, },
108 	{ "sprd,phy-delay-sd-uhs-sdr50", MMC_TIMING_UHS_SDR50, },
109 	{ "sprd,phy-delay-sd-uhs-sdr104", MMC_TIMING_UHS_SDR104, },
110 	{ "sprd,phy-delay-mmc-highspeed", MMC_TIMING_MMC_HS, },
111 	{ "sprd,phy-delay-mmc-ddr52", MMC_TIMING_MMC_DDR52, },
112 	{ "sprd,phy-delay-mmc-hs200", MMC_TIMING_MMC_HS200, },
113 	{ "sprd,phy-delay-mmc-hs400", MMC_TIMING_MMC_HS400, },
114 	{ "sprd,phy-delay-mmc-hs400es", MMC_TIMING_MMC_HS400 + 1, },
115 };
116 
117 #define TO_SPRD_HOST(host) sdhci_pltfm_priv(sdhci_priv(host))
118 
119 static void sdhci_sprd_init_config(struct sdhci_host *host)
120 {
121 	u16 val;
122 
123 	/* set dll backup mode */
124 	val = sdhci_readl(host, SDHCI_SPRD_REG_DEBOUNCE);
125 	val |= SDHCI_SPRD_BIT_DLL_BAK | SDHCI_SPRD_BIT_DLL_VAL;
126 	sdhci_writel(host, val, SDHCI_SPRD_REG_DEBOUNCE);
127 }
128 
129 static inline u32 sdhci_sprd_readl(struct sdhci_host *host, int reg)
130 {
131 	if (unlikely(reg == SDHCI_MAX_CURRENT))
132 		return SDHCI_SPRD_MAX_CUR;
133 
134 	return readl_relaxed(host->ioaddr + reg);
135 }
136 
137 static inline void sdhci_sprd_writel(struct sdhci_host *host, u32 val, int reg)
138 {
139 	/* SDHCI_MAX_CURRENT is reserved on Spreadtrum's platform */
140 	if (unlikely(reg == SDHCI_MAX_CURRENT))
141 		return;
142 
143 	if (unlikely(reg == SDHCI_SIGNAL_ENABLE || reg == SDHCI_INT_ENABLE))
144 		val = val & SDHCI_SPRD_INT_SIGNAL_MASK;
145 
146 	writel_relaxed(val, host->ioaddr + reg);
147 }
148 
149 static inline void sdhci_sprd_writew(struct sdhci_host *host, u16 val, int reg)
150 {
151 	/* SDHCI_BLOCK_COUNT is Read Only on Spreadtrum's platform */
152 	if (unlikely(reg == SDHCI_BLOCK_COUNT))
153 		return;
154 
155 	writew_relaxed(val, host->ioaddr + reg);
156 }
157 
158 static inline void sdhci_sprd_writeb(struct sdhci_host *host, u8 val, int reg)
159 {
160 	/*
161 	 * Since BIT(3) of SDHCI_SOFTWARE_RESET is reserved according to the
162 	 * standard specification, sdhci_reset() write this register directly
163 	 * without checking other reserved bits, that will clear BIT(3) which
164 	 * is defined as hardware reset on Spreadtrum's platform and clearing
165 	 * it by mistake will lead the card not work. So here we need to work
166 	 * around it.
167 	 */
168 	if (unlikely(reg == SDHCI_SOFTWARE_RESET)) {
169 		if (readb_relaxed(host->ioaddr + reg) & SDHCI_HW_RESET_CARD)
170 			val |= SDHCI_HW_RESET_CARD;
171 	}
172 
173 	writeb_relaxed(val, host->ioaddr + reg);
174 }
175 
176 static inline void sdhci_sprd_sd_clk_off(struct sdhci_host *host)
177 {
178 	u16 ctrl = sdhci_readw(host, SDHCI_CLOCK_CONTROL);
179 
180 	ctrl &= ~SDHCI_CLOCK_CARD_EN;
181 	sdhci_writew(host, ctrl, SDHCI_CLOCK_CONTROL);
182 }
183 
184 static inline void sdhci_sprd_sd_clk_on(struct sdhci_host *host)
185 {
186 	u16 ctrl;
187 
188 	ctrl = sdhci_readw(host, SDHCI_CLOCK_CONTROL);
189 	ctrl |= SDHCI_CLOCK_CARD_EN;
190 	sdhci_writew(host, ctrl, SDHCI_CLOCK_CONTROL);
191 }
192 
193 static inline void
194 sdhci_sprd_set_dll_invert(struct sdhci_host *host, u32 mask, bool en)
195 {
196 	u32 dll_dly_offset;
197 
198 	dll_dly_offset = sdhci_readl(host, SDHCI_SPRD_REG_32_DLL_DLY_OFFSET);
199 	if (en)
200 		dll_dly_offset |= mask;
201 	else
202 		dll_dly_offset &= ~mask;
203 	sdhci_writel(host, dll_dly_offset, SDHCI_SPRD_REG_32_DLL_DLY_OFFSET);
204 }
205 
206 static inline u32 sdhci_sprd_calc_div(u32 base_clk, u32 clk)
207 {
208 	u32 div;
209 
210 	/* select 2x clock source */
211 	if (base_clk <= clk * 2)
212 		return 0;
213 
214 	div = (u32) (base_clk / (clk * 2));
215 
216 	if ((base_clk / div) > (clk * 2))
217 		div++;
218 
219 	if (div % 2)
220 		div = (div + 1) / 2;
221 	else
222 		div = div / 2;
223 
224 	if (div > SDHCI_SPRD_CLK_MAX_DIV)
225 		div = SDHCI_SPRD_CLK_MAX_DIV;
226 
227 	return div;
228 }
229 
230 static inline void _sdhci_sprd_set_clock(struct sdhci_host *host,
231 					unsigned int clk)
232 {
233 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
234 	u32 div, val, mask;
235 
236 	sdhci_writew(host, 0, SDHCI_CLOCK_CONTROL);
237 
238 	div = sdhci_sprd_calc_div(sprd_host->base_rate, clk);
239 	div = ((div & 0x300) >> 2) | ((div & 0xFF) << 8);
240 	sdhci_enable_clk(host, div);
241 
242 	val = sdhci_readl(host, SDHCI_SPRD_REG_32_BUSY_POSI);
243 	mask = SDHCI_SPRD_BIT_OUTR_CLK_AUTO_EN | SDHCI_SPRD_BIT_INNR_CLK_AUTO_EN;
244 	/* Enable CLK_AUTO when the clock is greater than 400K. */
245 	if (clk > 400000) {
246 		if (mask != (val & mask)) {
247 			val |= mask;
248 			sdhci_writel(host, val, SDHCI_SPRD_REG_32_BUSY_POSI);
249 		}
250 	} else {
251 		if (val & mask) {
252 			val &= ~mask;
253 			sdhci_writel(host, val, SDHCI_SPRD_REG_32_BUSY_POSI);
254 		}
255 	}
256 }
257 
258 static void sdhci_sprd_enable_phy_dll(struct sdhci_host *host)
259 {
260 	u32 tmp;
261 
262 	tmp = sdhci_readl(host, SDHCI_SPRD_REG_32_DLL_CFG);
263 	tmp &= ~(SDHCI_SPRD_DLL_EN | SDHCI_SPRD_DLL_ALL_CPST_EN);
264 	sdhci_writel(host, tmp, SDHCI_SPRD_REG_32_DLL_CFG);
265 	/* wait 1ms */
266 	usleep_range(1000, 1250);
267 
268 	tmp = sdhci_readl(host, SDHCI_SPRD_REG_32_DLL_CFG);
269 	tmp |= SDHCI_SPRD_DLL_ALL_CPST_EN | SDHCI_SPRD_DLL_SEARCH_MODE |
270 		SDHCI_SPRD_DLL_INIT_COUNT | SDHCI_SPRD_DLL_PHASE_INTERNAL;
271 	sdhci_writel(host, tmp, SDHCI_SPRD_REG_32_DLL_CFG);
272 	/* wait 1ms */
273 	usleep_range(1000, 1250);
274 
275 	tmp = sdhci_readl(host, SDHCI_SPRD_REG_32_DLL_CFG);
276 	tmp |= SDHCI_SPRD_DLL_EN;
277 	sdhci_writel(host, tmp, SDHCI_SPRD_REG_32_DLL_CFG);
278 	/* wait 1ms */
279 	usleep_range(1000, 1250);
280 
281 	if (read_poll_timeout(sdhci_readl, tmp, (tmp & SDHCI_SPRD_DLL_LOCKED),
282 		2000, USEC_PER_SEC, false, host, SDHCI_SPRD_REG_32_DLL_STS0)) {
283 		pr_err("%s: DLL locked fail!\n", mmc_hostname(host->mmc));
284 		pr_info("%s: DLL_STS0 : 0x%x, DLL_CFG : 0x%x\n",
285 			 mmc_hostname(host->mmc),
286 			 sdhci_readl(host, SDHCI_SPRD_REG_32_DLL_STS0),
287 			 sdhci_readl(host, SDHCI_SPRD_REG_32_DLL_CFG));
288 	}
289 }
290 
291 static void sdhci_sprd_set_clock(struct sdhci_host *host, unsigned int clock)
292 {
293 	bool en = false, clk_changed = false;
294 
295 	if (clock == 0) {
296 		sdhci_writew(host, 0, SDHCI_CLOCK_CONTROL);
297 	} else if (clock != host->clock) {
298 		sdhci_sprd_sd_clk_off(host);
299 		_sdhci_sprd_set_clock(host, clock);
300 
301 		if (clock <= 400000)
302 			en = true;
303 		sdhci_sprd_set_dll_invert(host, SDHCI_SPRD_BIT_CMD_DLY_INV |
304 					  SDHCI_SPRD_BIT_POSRD_DLY_INV, en);
305 		clk_changed = true;
306 	} else {
307 		_sdhci_sprd_set_clock(host, clock);
308 	}
309 
310 	/*
311 	 * According to the Spreadtrum SD host specification, when we changed
312 	 * the clock to be more than 52M, we should enable the PHY DLL which
313 	 * is used to track the clock frequency to make the clock work more
314 	 * stable. Otherwise deviation may occur of the higher clock.
315 	 */
316 	if (clk_changed && clock > SDHCI_SPRD_PHY_DLL_CLK)
317 		sdhci_sprd_enable_phy_dll(host);
318 }
319 
320 static unsigned int sdhci_sprd_get_max_clock(struct sdhci_host *host)
321 {
322 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
323 
324 	return clk_round_rate(sprd_host->clk_sdio, ULONG_MAX);
325 }
326 
327 static unsigned int sdhci_sprd_get_min_clock(struct sdhci_host *host)
328 {
329 	return 100000;
330 }
331 
332 static void sdhci_sprd_set_uhs_signaling(struct sdhci_host *host,
333 					 unsigned int timing)
334 {
335 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
336 	struct mmc_host *mmc = host->mmc;
337 	u32 *p = sprd_host->phy_delay;
338 	u16 ctrl_2;
339 
340 	if (timing == host->timing)
341 		return;
342 
343 	ctrl_2 = sdhci_readw(host, SDHCI_HOST_CONTROL2);
344 	/* Select Bus Speed Mode for host */
345 	ctrl_2 &= ~SDHCI_CTRL_UHS_MASK;
346 	switch (timing) {
347 	case MMC_TIMING_UHS_SDR12:
348 		ctrl_2 |= SDHCI_CTRL_UHS_SDR12;
349 		break;
350 	case MMC_TIMING_MMC_HS:
351 	case MMC_TIMING_SD_HS:
352 	case MMC_TIMING_UHS_SDR25:
353 		ctrl_2 |= SDHCI_CTRL_UHS_SDR25;
354 		break;
355 	case MMC_TIMING_UHS_SDR50:
356 		ctrl_2 |= SDHCI_CTRL_UHS_SDR50;
357 		break;
358 	case MMC_TIMING_UHS_SDR104:
359 		ctrl_2 |= SDHCI_CTRL_UHS_SDR104;
360 		break;
361 	case MMC_TIMING_UHS_DDR50:
362 	case MMC_TIMING_MMC_DDR52:
363 		ctrl_2 |= SDHCI_CTRL_UHS_DDR50;
364 		break;
365 	case MMC_TIMING_MMC_HS200:
366 		ctrl_2 |= SDHCI_SPRD_CTRL_HS200;
367 		break;
368 	case MMC_TIMING_MMC_HS400:
369 		ctrl_2 |= SDHCI_SPRD_CTRL_HS400;
370 		break;
371 	default:
372 		break;
373 	}
374 
375 	sdhci_writew(host, ctrl_2, SDHCI_HOST_CONTROL2);
376 
377 	if (!mmc->ios.enhanced_strobe)
378 		sdhci_writel(host, p[timing], SDHCI_SPRD_REG_32_DLL_DLY);
379 }
380 
381 static void sdhci_sprd_hw_reset(struct sdhci_host *host)
382 {
383 	int val;
384 
385 	/*
386 	 * Note: don't use sdhci_writeb() API here since it is redirected to
387 	 * sdhci_sprd_writeb() in which we have a workaround for
388 	 * SDHCI_SOFTWARE_RESET which would make bit SDHCI_HW_RESET_CARD can
389 	 * not be cleared.
390 	 */
391 	val = readb_relaxed(host->ioaddr + SDHCI_SOFTWARE_RESET);
392 	val &= ~SDHCI_HW_RESET_CARD;
393 	writeb_relaxed(val, host->ioaddr + SDHCI_SOFTWARE_RESET);
394 	/* wait for 10 us */
395 	usleep_range(10, 20);
396 
397 	val |= SDHCI_HW_RESET_CARD;
398 	writeb_relaxed(val, host->ioaddr + SDHCI_SOFTWARE_RESET);
399 	usleep_range(300, 500);
400 }
401 
402 static unsigned int sdhci_sprd_get_max_timeout_count(struct sdhci_host *host)
403 {
404 	/* The Spredtrum controller actual maximum timeout count is 1 << 31 */
405 	return 1 << 31;
406 }
407 
408 static unsigned int sdhci_sprd_get_ro(struct sdhci_host *host)
409 {
410 	return 0;
411 }
412 
413 static void sdhci_sprd_request_done(struct sdhci_host *host,
414 				    struct mmc_request *mrq)
415 {
416 	/* Validate if the request was from software queue firstly. */
417 	if (mmc_hsq_finalize_request(host->mmc, mrq))
418 		return;
419 
420 	mmc_request_done(host->mmc, mrq);
421 }
422 
423 static void sdhci_sprd_set_power(struct sdhci_host *host, unsigned char mode,
424 				 unsigned short vdd)
425 {
426 	struct mmc_host *mmc = host->mmc;
427 
428 	switch (mode) {
429 	case MMC_POWER_OFF:
430 		mmc_regulator_set_ocr(host->mmc, mmc->supply.vmmc, 0);
431 
432 		mmc_regulator_disable_vqmmc(mmc);
433 		break;
434 	case MMC_POWER_ON:
435 		mmc_regulator_enable_vqmmc(mmc);
436 		break;
437 	case MMC_POWER_UP:
438 		mmc_regulator_set_ocr(host->mmc, mmc->supply.vmmc, vdd);
439 		break;
440 	}
441 }
442 
443 static struct sdhci_ops sdhci_sprd_ops = {
444 	.read_l = sdhci_sprd_readl,
445 	.write_l = sdhci_sprd_writel,
446 	.write_w = sdhci_sprd_writew,
447 	.write_b = sdhci_sprd_writeb,
448 	.set_clock = sdhci_sprd_set_clock,
449 	.set_power = sdhci_sprd_set_power,
450 	.get_max_clock = sdhci_sprd_get_max_clock,
451 	.get_min_clock = sdhci_sprd_get_min_clock,
452 	.set_bus_width = sdhci_set_bus_width,
453 	.reset = sdhci_reset,
454 	.set_uhs_signaling = sdhci_sprd_set_uhs_signaling,
455 	.hw_reset = sdhci_sprd_hw_reset,
456 	.get_max_timeout_count = sdhci_sprd_get_max_timeout_count,
457 	.get_ro = sdhci_sprd_get_ro,
458 	.request_done = sdhci_sprd_request_done,
459 };
460 
461 static void sdhci_sprd_check_auto_cmd23(struct mmc_host *mmc,
462 					struct mmc_request *mrq)
463 {
464 	struct sdhci_host *host = mmc_priv(mmc);
465 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
466 
467 	host->flags |= sprd_host->flags & SDHCI_AUTO_CMD23;
468 
469 	/*
470 	 * From version 4.10 onward, ARGUMENT2 register is also as 32-bit
471 	 * block count register which doesn't support stuff bits of
472 	 * CMD23 argument on Spreadtrum's sd host controller.
473 	 */
474 	if (host->version >= SDHCI_SPEC_410 &&
475 	    mrq->sbc && (mrq->sbc->arg & SDHCI_SPRD_ARG2_STUFF) &&
476 	    (host->flags & SDHCI_AUTO_CMD23))
477 		host->flags &= ~SDHCI_AUTO_CMD23;
478 }
479 
480 static void sdhci_sprd_request(struct mmc_host *mmc, struct mmc_request *mrq)
481 {
482 	sdhci_sprd_check_auto_cmd23(mmc, mrq);
483 
484 	sdhci_request(mmc, mrq);
485 }
486 
487 static int sdhci_sprd_request_atomic(struct mmc_host *mmc,
488 				     struct mmc_request *mrq)
489 {
490 	sdhci_sprd_check_auto_cmd23(mmc, mrq);
491 
492 	return sdhci_request_atomic(mmc, mrq);
493 }
494 
495 static int sdhci_sprd_voltage_switch(struct mmc_host *mmc, struct mmc_ios *ios)
496 {
497 	struct sdhci_host *host = mmc_priv(mmc);
498 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
499 	int ret;
500 
501 	if (!IS_ERR(mmc->supply.vqmmc)) {
502 		ret = mmc_regulator_set_vqmmc(mmc, ios);
503 		if (ret < 0) {
504 			pr_err("%s: Switching signalling voltage failed\n",
505 			       mmc_hostname(mmc));
506 			return ret;
507 		}
508 	}
509 
510 	if (IS_ERR(sprd_host->pinctrl))
511 		goto reset;
512 
513 	switch (ios->signal_voltage) {
514 	case MMC_SIGNAL_VOLTAGE_180:
515 		ret = pinctrl_select_state(sprd_host->pinctrl,
516 					   sprd_host->pins_uhs);
517 		if (ret) {
518 			pr_err("%s: failed to select uhs pin state\n",
519 			       mmc_hostname(mmc));
520 			return ret;
521 		}
522 		break;
523 
524 	default:
525 		fallthrough;
526 	case MMC_SIGNAL_VOLTAGE_330:
527 		ret = pinctrl_select_state(sprd_host->pinctrl,
528 					   sprd_host->pins_default);
529 		if (ret) {
530 			pr_err("%s: failed to select default pin state\n",
531 			       mmc_hostname(mmc));
532 			return ret;
533 		}
534 		break;
535 	}
536 
537 	/* Wait for 300 ~ 500 us for pin state stable */
538 	usleep_range(300, 500);
539 
540 reset:
541 	sdhci_reset(host, SDHCI_RESET_CMD | SDHCI_RESET_DATA);
542 
543 	return 0;
544 }
545 
546 static void sdhci_sprd_hs400_enhanced_strobe(struct mmc_host *mmc,
547 					     struct mmc_ios *ios)
548 {
549 	struct sdhci_host *host = mmc_priv(mmc);
550 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
551 	u32 *p = sprd_host->phy_delay;
552 	u16 ctrl_2;
553 
554 	if (!ios->enhanced_strobe)
555 		return;
556 
557 	sdhci_sprd_sd_clk_off(host);
558 
559 	/* Set HS400 enhanced strobe mode */
560 	ctrl_2 = sdhci_readw(host, SDHCI_HOST_CONTROL2);
561 	ctrl_2 &= ~SDHCI_CTRL_UHS_MASK;
562 	ctrl_2 |= SDHCI_SPRD_CTRL_HS400ES;
563 	sdhci_writew(host, ctrl_2, SDHCI_HOST_CONTROL2);
564 
565 	sdhci_sprd_sd_clk_on(host);
566 
567 	/* Set the PHY DLL delay value for HS400 enhanced strobe mode */
568 	sdhci_writel(host, p[MMC_TIMING_MMC_HS400 + 1],
569 		     SDHCI_SPRD_REG_32_DLL_DLY);
570 }
571 
572 static int mmc_send_tuning_cmd(struct mmc_card *card)
573 {
574 	return mmc_send_status(card, NULL);
575 }
576 
577 static int mmc_send_tuning_data(struct mmc_card *card)
578 {
579 	u8 *status;
580 	int ret;
581 
582 	status = kmalloc(64, GFP_KERNEL);
583 	if (!status)
584 		return -ENOMEM;
585 
586 	ret = mmc_sd_switch(card, 0, 0, 0, status);
587 
588 	kfree(status);
589 
590 	return ret;
591 }
592 
593 static int sdhci_sprd_get_best_clk_sample(struct mmc_host *mmc, u8 *value)
594 {
595 	int range_end = SDHCI_SPRD_MAX_RANGE;
596 	int range_length = 0;
597 	int middle_range = 0;
598 	int count = 0;
599 	int i;
600 
601 	for (i = 0; i <= SDHCI_SPRD_MAX_RANGE; i++) {
602 		if (value[i]) {
603 			pr_debug("%s: tuning ok: %d\n", mmc_hostname(mmc), i);
604 			count++;
605 		} else {
606 			pr_debug("%s: tuning fail: %d\n", mmc_hostname(mmc), i);
607 			if (range_length < count) {
608 				range_length = count;
609 				range_end = i - 1;
610 				count = 0;
611 			}
612 		}
613 	}
614 
615 	if (!count)
616 		return -EIO;
617 
618 	if (count > range_length) {
619 		range_length = count;
620 		range_end = i - 1;
621 	}
622 
623 	middle_range = range_end - (range_length - 1) / 2;
624 
625 	return middle_range;
626 }
627 
628 static int sdhci_sprd_tuning(struct mmc_host *mmc, struct mmc_card *card,
629 			enum sdhci_sprd_tuning_type type)
630 {
631 	struct sdhci_host *host = mmc_priv(mmc);
632 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
633 	u32 *p = sprd_host->phy_delay;
634 	u32 dll_cfg, dll_dly;
635 	int best_clk_sample;
636 	int err = 0;
637 	u8 *value;
638 	int i;
639 
640 	value = kmalloc(SDHCI_SPRD_MAX_RANGE + 1, GFP_KERNEL);
641 	if (!value)
642 		return -ENOMEM;
643 
644 	sdhci_reset(host, SDHCI_RESET_CMD | SDHCI_RESET_DATA);
645 
646 	dll_cfg = sdhci_readl(host, SDHCI_SPRD_REG_32_DLL_CFG);
647 	dll_cfg &= ~SDHCI_SPRD_CPST_EN;
648 	sdhci_writel(host, dll_cfg, SDHCI_SPRD_REG_32_DLL_CFG);
649 
650 	dll_dly = p[mmc->ios.timing];
651 
652 	for (i = 0; i <= SDHCI_SPRD_MAX_RANGE; i++) {
653 		if (type == SDHCI_SPRD_TUNING_SD_HS_CMD) {
654 			dll_dly &= ~SDHCI_SPRD_CMD_DLY_MASK;
655 			dll_dly |= ((i << 8) & SDHCI_SPRD_CMD_DLY_MASK);
656 		} else {
657 			dll_dly &= ~SDHCI_SPRD_POSRD_DLY_MASK;
658 			dll_dly |= ((i << 16) & SDHCI_SPRD_POSRD_DLY_MASK);
659 		}
660 
661 		sdhci_writel(host, dll_dly, SDHCI_SPRD_REG_32_DLL_DLY);
662 
663 		if (type == SDHCI_SPRD_TUNING_SD_HS_CMD)
664 			value[i] = !mmc_send_tuning_cmd(card);
665 		else
666 			value[i] = !mmc_send_tuning_data(card);
667 	}
668 
669 	best_clk_sample = sdhci_sprd_get_best_clk_sample(mmc, value);
670 	if (best_clk_sample < 0) {
671 		dev_err(mmc_dev(host->mmc), "all tuning phase fail!\n");
672 		err = best_clk_sample;
673 		goto out;
674 	}
675 
676 	if (type == SDHCI_SPRD_TUNING_SD_HS_CMD) {
677 		p[mmc->ios.timing] &= ~SDHCI_SPRD_CMD_DLY_MASK;
678 		p[mmc->ios.timing] |= ((best_clk_sample << 8) & SDHCI_SPRD_CMD_DLY_MASK);
679 	} else {
680 		p[mmc->ios.timing] &= ~(SDHCI_SPRD_POSRD_DLY_MASK);
681 		p[mmc->ios.timing] |= ((best_clk_sample << 16) & SDHCI_SPRD_POSRD_DLY_MASK);
682 	}
683 
684 	pr_debug("%s: the best clk sample %d, delay value 0x%08x\n",
685 			mmc_hostname(host->mmc), best_clk_sample, p[mmc->ios.timing]);
686 
687 out:
688 	sdhci_writel(host, p[mmc->ios.timing], SDHCI_SPRD_REG_32_DLL_DLY);
689 
690 	kfree(value);
691 
692 	return err;
693 }
694 
695 static int sdhci_sprd_prepare_sd_hs_cmd_tuning(struct mmc_host *mmc, struct mmc_card *card)
696 {
697 	return sdhci_sprd_tuning(mmc, card, SDHCI_SPRD_TUNING_SD_HS_CMD);
698 }
699 
700 static int sdhci_sprd_execute_sd_hs_data_tuning(struct mmc_host *mmc, struct mmc_card *card)
701 {
702 	return sdhci_sprd_tuning(mmc, card, SDHCI_SPRD_TUNING_SD_HS_DATA);
703 }
704 
705 static void sdhci_sprd_phy_param_parse(struct sdhci_sprd_host *sprd_host,
706 				       struct device_node *np)
707 {
708 	u32 *p = sprd_host->phy_delay;
709 	int ret, i, index;
710 	u32 val[4];
711 
712 	for (i = 0; i < ARRAY_SIZE(sdhci_sprd_phy_cfgs); i++) {
713 		ret = of_property_read_u32_array(np,
714 				sdhci_sprd_phy_cfgs[i].property, val, 4);
715 		if (ret)
716 			continue;
717 
718 		index = sdhci_sprd_phy_cfgs[i].timing;
719 		p[index] = val[0] | (val[1] << 8) | (val[2] << 16) | (val[3] << 24);
720 	}
721 }
722 
723 static const struct sdhci_pltfm_data sdhci_sprd_pdata = {
724 	.quirks = SDHCI_QUIRK_BROKEN_CARD_DETECTION |
725 		  SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK,
726 	.quirks2 = SDHCI_QUIRK2_BROKEN_HS200 |
727 		   SDHCI_QUIRK2_USE_32BIT_BLK_CNT |
728 		   SDHCI_QUIRK2_PRESET_VALUE_BROKEN,
729 	.ops = &sdhci_sprd_ops,
730 };
731 
732 static int sdhci_sprd_probe(struct platform_device *pdev)
733 {
734 	struct sdhci_host *host;
735 	struct sdhci_sprd_host *sprd_host;
736 	struct mmc_hsq *hsq;
737 	struct clk *clk;
738 	int ret = 0;
739 
740 	host = sdhci_pltfm_init(pdev, &sdhci_sprd_pdata, sizeof(*sprd_host));
741 	if (IS_ERR(host))
742 		return PTR_ERR(host);
743 
744 	host->dma_mask = DMA_BIT_MASK(64);
745 	pdev->dev.dma_mask = &host->dma_mask;
746 	host->mmc_host_ops.request = sdhci_sprd_request;
747 	host->mmc_host_ops.hs400_enhanced_strobe =
748 		sdhci_sprd_hs400_enhanced_strobe;
749 	host->mmc_host_ops.prepare_sd_hs_tuning =
750 		sdhci_sprd_prepare_sd_hs_cmd_tuning;
751 	host->mmc_host_ops.execute_sd_hs_tuning =
752 		sdhci_sprd_execute_sd_hs_data_tuning;
753 
754 	/*
755 	 * We can not use the standard ops to change and detect the voltage
756 	 * signal for Spreadtrum SD host controller, since our voltage regulator
757 	 * for I/O is fixed in hardware, that means we do not need control
758 	 * the standard SD host controller to change the I/O voltage.
759 	 */
760 	host->mmc_host_ops.start_signal_voltage_switch =
761 		sdhci_sprd_voltage_switch;
762 
763 	host->mmc->caps = MMC_CAP_SD_HIGHSPEED | MMC_CAP_MMC_HIGHSPEED |
764 		MMC_CAP_WAIT_WHILE_BUSY;
765 
766 	ret = mmc_of_parse(host->mmc);
767 	if (ret)
768 		goto pltfm_free;
769 
770 	if (!mmc_card_is_removable(host->mmc))
771 		host->mmc_host_ops.request_atomic = sdhci_sprd_request_atomic;
772 	else
773 		host->always_defer_done = true;
774 
775 	sprd_host = TO_SPRD_HOST(host);
776 	sdhci_sprd_phy_param_parse(sprd_host, pdev->dev.of_node);
777 
778 	sprd_host->pinctrl = devm_pinctrl_get(&pdev->dev);
779 	if (!IS_ERR(sprd_host->pinctrl)) {
780 		sprd_host->pins_uhs =
781 			pinctrl_lookup_state(sprd_host->pinctrl, "state_uhs");
782 		if (IS_ERR(sprd_host->pins_uhs)) {
783 			ret = PTR_ERR(sprd_host->pins_uhs);
784 			goto pltfm_free;
785 		}
786 
787 		sprd_host->pins_default =
788 			pinctrl_lookup_state(sprd_host->pinctrl, "default");
789 		if (IS_ERR(sprd_host->pins_default)) {
790 			ret = PTR_ERR(sprd_host->pins_default);
791 			goto pltfm_free;
792 		}
793 	}
794 
795 	clk = devm_clk_get(&pdev->dev, "sdio");
796 	if (IS_ERR(clk)) {
797 		ret = PTR_ERR(clk);
798 		goto pltfm_free;
799 	}
800 	sprd_host->clk_sdio = clk;
801 	sprd_host->base_rate = clk_get_rate(sprd_host->clk_sdio);
802 	if (!sprd_host->base_rate)
803 		sprd_host->base_rate = SDHCI_SPRD_CLK_DEF_RATE;
804 
805 	clk = devm_clk_get(&pdev->dev, "enable");
806 	if (IS_ERR(clk)) {
807 		ret = PTR_ERR(clk);
808 		goto pltfm_free;
809 	}
810 	sprd_host->clk_enable = clk;
811 
812 	clk = devm_clk_get(&pdev->dev, "2x_enable");
813 	if (!IS_ERR(clk))
814 		sprd_host->clk_2x_enable = clk;
815 
816 	ret = clk_prepare_enable(sprd_host->clk_sdio);
817 	if (ret)
818 		goto pltfm_free;
819 
820 	ret = clk_prepare_enable(sprd_host->clk_enable);
821 	if (ret)
822 		goto clk_disable;
823 
824 	ret = clk_prepare_enable(sprd_host->clk_2x_enable);
825 	if (ret)
826 		goto clk_disable2;
827 
828 	sdhci_sprd_init_config(host);
829 	host->version = sdhci_readw(host, SDHCI_HOST_VERSION);
830 	sprd_host->version = ((host->version & SDHCI_VENDOR_VER_MASK) >>
831 			       SDHCI_VENDOR_VER_SHIFT);
832 
833 	pm_runtime_get_noresume(&pdev->dev);
834 	pm_runtime_set_active(&pdev->dev);
835 	pm_runtime_enable(&pdev->dev);
836 	pm_runtime_set_autosuspend_delay(&pdev->dev, 50);
837 	pm_runtime_use_autosuspend(&pdev->dev);
838 	pm_suspend_ignore_children(&pdev->dev, 1);
839 
840 	sdhci_enable_v4_mode(host);
841 
842 	/*
843 	 * Supply the existing CAPS, but clear the UHS-I modes. This
844 	 * will allow these modes to be specified only by device
845 	 * tree properties through mmc_of_parse().
846 	 */
847 	sdhci_read_caps(host);
848 	host->caps1 &= ~(SDHCI_SUPPORT_SDR50 | SDHCI_SUPPORT_SDR104 |
849 			 SDHCI_SUPPORT_DDR50);
850 
851 	ret = mmc_regulator_get_supply(host->mmc);
852 	if (ret)
853 		goto pm_runtime_disable;
854 
855 	ret = sdhci_setup_host(host);
856 	if (ret)
857 		goto pm_runtime_disable;
858 
859 	sprd_host->flags = host->flags;
860 
861 	hsq = devm_kzalloc(&pdev->dev, sizeof(*hsq), GFP_KERNEL);
862 	if (!hsq) {
863 		ret = -ENOMEM;
864 		goto err_cleanup_host;
865 	}
866 
867 	ret = mmc_hsq_init(hsq, host->mmc);
868 	if (ret)
869 		goto err_cleanup_host;
870 
871 	ret = __sdhci_add_host(host);
872 	if (ret)
873 		goto err_cleanup_host;
874 
875 	pm_runtime_mark_last_busy(&pdev->dev);
876 	pm_runtime_put_autosuspend(&pdev->dev);
877 
878 	return 0;
879 
880 err_cleanup_host:
881 	sdhci_cleanup_host(host);
882 
883 pm_runtime_disable:
884 	pm_runtime_put_noidle(&pdev->dev);
885 	pm_runtime_disable(&pdev->dev);
886 	pm_runtime_set_suspended(&pdev->dev);
887 
888 	clk_disable_unprepare(sprd_host->clk_2x_enable);
889 
890 clk_disable2:
891 	clk_disable_unprepare(sprd_host->clk_enable);
892 
893 clk_disable:
894 	clk_disable_unprepare(sprd_host->clk_sdio);
895 
896 pltfm_free:
897 	sdhci_pltfm_free(pdev);
898 	return ret;
899 }
900 
901 static void sdhci_sprd_remove(struct platform_device *pdev)
902 {
903 	struct sdhci_host *host = platform_get_drvdata(pdev);
904 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
905 
906 	sdhci_remove_host(host, 0);
907 
908 	clk_disable_unprepare(sprd_host->clk_sdio);
909 	clk_disable_unprepare(sprd_host->clk_enable);
910 	clk_disable_unprepare(sprd_host->clk_2x_enable);
911 
912 	sdhci_pltfm_free(pdev);
913 }
914 
915 static const struct of_device_id sdhci_sprd_of_match[] = {
916 	{ .compatible = "sprd,sdhci-r11", },
917 	{ }
918 };
919 MODULE_DEVICE_TABLE(of, sdhci_sprd_of_match);
920 
921 #ifdef CONFIG_PM
922 static int sdhci_sprd_runtime_suspend(struct device *dev)
923 {
924 	struct sdhci_host *host = dev_get_drvdata(dev);
925 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
926 
927 	mmc_hsq_suspend(host->mmc);
928 	sdhci_runtime_suspend_host(host);
929 
930 	clk_disable_unprepare(sprd_host->clk_sdio);
931 	clk_disable_unprepare(sprd_host->clk_enable);
932 	clk_disable_unprepare(sprd_host->clk_2x_enable);
933 
934 	return 0;
935 }
936 
937 static int sdhci_sprd_runtime_resume(struct device *dev)
938 {
939 	struct sdhci_host *host = dev_get_drvdata(dev);
940 	struct sdhci_sprd_host *sprd_host = TO_SPRD_HOST(host);
941 	int ret;
942 
943 	ret = clk_prepare_enable(sprd_host->clk_2x_enable);
944 	if (ret)
945 		return ret;
946 
947 	ret = clk_prepare_enable(sprd_host->clk_enable);
948 	if (ret)
949 		goto clk_2x_disable;
950 
951 	ret = clk_prepare_enable(sprd_host->clk_sdio);
952 	if (ret)
953 		goto clk_disable;
954 
955 	sdhci_runtime_resume_host(host, 1);
956 	mmc_hsq_resume(host->mmc);
957 
958 	return 0;
959 
960 clk_disable:
961 	clk_disable_unprepare(sprd_host->clk_enable);
962 
963 clk_2x_disable:
964 	clk_disable_unprepare(sprd_host->clk_2x_enable);
965 
966 	return ret;
967 }
968 #endif
969 
970 static const struct dev_pm_ops sdhci_sprd_pm_ops = {
971 	SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
972 				pm_runtime_force_resume)
973 	SET_RUNTIME_PM_OPS(sdhci_sprd_runtime_suspend,
974 			   sdhci_sprd_runtime_resume, NULL)
975 };
976 
977 static struct platform_driver sdhci_sprd_driver = {
978 	.probe = sdhci_sprd_probe,
979 	.remove_new = sdhci_sprd_remove,
980 	.driver = {
981 		.name = "sdhci_sprd_r11",
982 		.probe_type = PROBE_PREFER_ASYNCHRONOUS,
983 		.of_match_table = sdhci_sprd_of_match,
984 		.pm = &sdhci_sprd_pm_ops,
985 	},
986 };
987 module_platform_driver(sdhci_sprd_driver);
988 
989 MODULE_DESCRIPTION("Spreadtrum sdio host controller r11 driver");
990 MODULE_LICENSE("GPL v2");
991 MODULE_ALIAS("platform:sdhci-sprd-r11");
992