xref: /rk3399_rockchip-uboot/drivers/mmc/fsl_esdhc.c (revision d6eb25e9878617f9a1d7f06ec21c9b981bb0a4e5)
1 /*
2  * Copyright 2007, 2010-2011 Freescale Semiconductor, Inc
3  * Andy Fleming
4  *
5  * Based vaguely on the pxa mmc code:
6  * (C) Copyright 2003
7  * Kyle Harris, Nexus Technologies, Inc. kharris@nexus-tech.net
8  *
9  * SPDX-License-Identifier:	GPL-2.0+
10  */
11 
12 #include <config.h>
13 #include <common.h>
14 #include <command.h>
15 #include <errno.h>
16 #include <hwconfig.h>
17 #include <mmc.h>
18 #include <part.h>
19 #include <power/regulator.h>
20 #include <malloc.h>
21 #include <fsl_esdhc.h>
22 #include <fdt_support.h>
23 #include <asm/io.h>
24 #include <dm.h>
25 #include <asm-generic/gpio.h>
26 
27 DECLARE_GLOBAL_DATA_PTR;
28 
29 #define SDHCI_IRQ_EN_BITS		(IRQSTATEN_CC | IRQSTATEN_TC | \
30 				IRQSTATEN_CINT | \
31 				IRQSTATEN_CTOE | IRQSTATEN_CCE | IRQSTATEN_CEBE | \
32 				IRQSTATEN_CIE | IRQSTATEN_DTOE | IRQSTATEN_DCE | \
33 				IRQSTATEN_DEBE | IRQSTATEN_BRR | IRQSTATEN_BWR | \
34 				IRQSTATEN_DINT)
35 
36 struct fsl_esdhc {
37 	uint    dsaddr;		/* SDMA system address register */
38 	uint    blkattr;	/* Block attributes register */
39 	uint    cmdarg;		/* Command argument register */
40 	uint    xfertyp;	/* Transfer type register */
41 	uint    cmdrsp0;	/* Command response 0 register */
42 	uint    cmdrsp1;	/* Command response 1 register */
43 	uint    cmdrsp2;	/* Command response 2 register */
44 	uint    cmdrsp3;	/* Command response 3 register */
45 	uint    datport;	/* Buffer data port register */
46 	uint    prsstat;	/* Present state register */
47 	uint    proctl;		/* Protocol control register */
48 	uint    sysctl;		/* System Control Register */
49 	uint    irqstat;	/* Interrupt status register */
50 	uint    irqstaten;	/* Interrupt status enable register */
51 	uint    irqsigen;	/* Interrupt signal enable register */
52 	uint    autoc12err;	/* Auto CMD error status register */
53 	uint    hostcapblt;	/* Host controller capabilities register */
54 	uint    wml;		/* Watermark level register */
55 	uint    mixctrl;	/* For USDHC */
56 	char    reserved1[4];	/* reserved */
57 	uint    fevt;		/* Force event register */
58 	uint    admaes;		/* ADMA error status register */
59 	uint    adsaddr;	/* ADMA system address register */
60 	char    reserved2[4];
61 	uint    dllctrl;
62 	uint    dllstat;
63 	uint    clktunectrlstatus;
64 	char    reserved3[84];
65 	uint    vendorspec;
66 	uint    mmcboot;
67 	uint    vendorspec2;
68 	char	reserved4[48];
69 	uint    hostver;	/* Host controller version register */
70 	char    reserved5[4];	/* reserved */
71 	uint    dmaerraddr;	/* DMA error address register */
72 	char    reserved6[4];	/* reserved */
73 	uint    dmaerrattr;	/* DMA error attribute register */
74 	char    reserved7[4];	/* reserved */
75 	uint    hostcapblt2;	/* Host controller capabilities register 2 */
76 	char    reserved8[8];	/* reserved */
77 	uint    tcr;		/* Tuning control register */
78 	char    reserved9[28];	/* reserved */
79 	uint    sddirctl;	/* SD direction control register */
80 	char    reserved10[712];/* reserved */
81 	uint    scr;		/* eSDHC control register */
82 };
83 
84 struct fsl_esdhc_plat {
85 	struct mmc_config cfg;
86 	struct mmc mmc;
87 };
88 
89 /**
90  * struct fsl_esdhc_priv
91  *
92  * @esdhc_regs: registers of the sdhc controller
93  * @sdhc_clk: Current clk of the sdhc controller
94  * @bus_width: bus width, 1bit, 4bit or 8bit
95  * @cfg: mmc config
96  * @mmc: mmc
97  * Following is used when Driver Model is enabled for MMC
98  * @dev: pointer for the device
99  * @non_removable: 0: removable; 1: non-removable
100  * @wp_enable: 1: enable checking wp; 0: no check
101  * @vs18_enable: 1: use 1.8V voltage; 0: use 3.3V
102  * @cd_gpio: gpio for card detection
103  * @wp_gpio: gpio for write protection
104  */
105 struct fsl_esdhc_priv {
106 	struct fsl_esdhc *esdhc_regs;
107 	unsigned int sdhc_clk;
108 	unsigned int bus_width;
109 	struct mmc *mmc;
110 	struct udevice *dev;
111 	int non_removable;
112 	int wp_enable;
113 	int vs18_enable;
114 #ifdef CONFIG_DM_GPIO
115 	struct gpio_desc cd_gpio;
116 	struct gpio_desc wp_gpio;
117 #endif
118 };
119 
120 /* Return the XFERTYP flags for a given command and data packet */
121 static uint esdhc_xfertyp(struct mmc_cmd *cmd, struct mmc_data *data)
122 {
123 	uint xfertyp = 0;
124 
125 	if (data) {
126 		xfertyp |= XFERTYP_DPSEL;
127 #ifndef CONFIG_SYS_FSL_ESDHC_USE_PIO
128 		xfertyp |= XFERTYP_DMAEN;
129 #endif
130 		if (data->blocks > 1) {
131 			xfertyp |= XFERTYP_MSBSEL;
132 			xfertyp |= XFERTYP_BCEN;
133 #ifdef CONFIG_SYS_FSL_ERRATUM_ESDHC111
134 			xfertyp |= XFERTYP_AC12EN;
135 #endif
136 		}
137 
138 		if (data->flags & MMC_DATA_READ)
139 			xfertyp |= XFERTYP_DTDSEL;
140 	}
141 
142 	if (cmd->resp_type & MMC_RSP_CRC)
143 		xfertyp |= XFERTYP_CCCEN;
144 	if (cmd->resp_type & MMC_RSP_OPCODE)
145 		xfertyp |= XFERTYP_CICEN;
146 	if (cmd->resp_type & MMC_RSP_136)
147 		xfertyp |= XFERTYP_RSPTYP_136;
148 	else if (cmd->resp_type & MMC_RSP_BUSY)
149 		xfertyp |= XFERTYP_RSPTYP_48_BUSY;
150 	else if (cmd->resp_type & MMC_RSP_PRESENT)
151 		xfertyp |= XFERTYP_RSPTYP_48;
152 
153 	if (cmd->cmdidx == MMC_CMD_STOP_TRANSMISSION)
154 		xfertyp |= XFERTYP_CMDTYP_ABORT;
155 
156 	return XFERTYP_CMD(cmd->cmdidx) | xfertyp;
157 }
158 
159 #ifdef CONFIG_SYS_FSL_ESDHC_USE_PIO
160 /*
161  * PIO Read/Write Mode reduce the performace as DMA is not used in this mode.
162  */
163 static void esdhc_pio_read_write(struct fsl_esdhc_priv *priv,
164 				 struct mmc_data *data)
165 {
166 	struct fsl_esdhc *regs = priv->esdhc_regs;
167 	uint blocks;
168 	char *buffer;
169 	uint databuf;
170 	uint size;
171 	uint irqstat;
172 	uint timeout;
173 
174 	if (data->flags & MMC_DATA_READ) {
175 		blocks = data->blocks;
176 		buffer = data->dest;
177 		while (blocks) {
178 			timeout = PIO_TIMEOUT;
179 			size = data->blocksize;
180 			irqstat = esdhc_read32(&regs->irqstat);
181 			while (!(esdhc_read32(&regs->prsstat) & PRSSTAT_BREN)
182 				&& --timeout);
183 			if (timeout <= 0) {
184 				printf("\nData Read Failed in PIO Mode.");
185 				return;
186 			}
187 			while (size && (!(irqstat & IRQSTAT_TC))) {
188 				udelay(100); /* Wait before last byte transfer complete */
189 				irqstat = esdhc_read32(&regs->irqstat);
190 				databuf = in_le32(&regs->datport);
191 				*((uint *)buffer) = databuf;
192 				buffer += 4;
193 				size -= 4;
194 			}
195 			blocks--;
196 		}
197 	} else {
198 		blocks = data->blocks;
199 		buffer = (char *)data->src;
200 		while (blocks) {
201 			timeout = PIO_TIMEOUT;
202 			size = data->blocksize;
203 			irqstat = esdhc_read32(&regs->irqstat);
204 			while (!(esdhc_read32(&regs->prsstat) & PRSSTAT_BWEN)
205 				&& --timeout);
206 			if (timeout <= 0) {
207 				printf("\nData Write Failed in PIO Mode.");
208 				return;
209 			}
210 			while (size && (!(irqstat & IRQSTAT_TC))) {
211 				udelay(100); /* Wait before last byte transfer complete */
212 				databuf = *((uint *)buffer);
213 				buffer += 4;
214 				size -= 4;
215 				irqstat = esdhc_read32(&regs->irqstat);
216 				out_le32(&regs->datport, databuf);
217 			}
218 			blocks--;
219 		}
220 	}
221 }
222 #endif
223 
224 static int esdhc_setup_data(struct fsl_esdhc_priv *priv, struct mmc *mmc,
225 			    struct mmc_data *data)
226 {
227 	int timeout;
228 	struct fsl_esdhc *regs = priv->esdhc_regs;
229 #if defined(CONFIG_FSL_LAYERSCAPE) || defined(CONFIG_S32V234)
230 	dma_addr_t addr;
231 #endif
232 	uint wml_value;
233 
234 	wml_value = data->blocksize/4;
235 
236 	if (data->flags & MMC_DATA_READ) {
237 		if (wml_value > WML_RD_WML_MAX)
238 			wml_value = WML_RD_WML_MAX_VAL;
239 
240 		esdhc_clrsetbits32(&regs->wml, WML_RD_WML_MASK, wml_value);
241 #ifndef CONFIG_SYS_FSL_ESDHC_USE_PIO
242 #if defined(CONFIG_FSL_LAYERSCAPE) || defined(CONFIG_S32V234)
243 		addr = virt_to_phys((void *)(data->dest));
244 		if (upper_32_bits(addr))
245 			printf("Error found for upper 32 bits\n");
246 		else
247 			esdhc_write32(&regs->dsaddr, lower_32_bits(addr));
248 #else
249 		esdhc_write32(&regs->dsaddr, (u32)data->dest);
250 #endif
251 #endif
252 	} else {
253 #ifndef CONFIG_SYS_FSL_ESDHC_USE_PIO
254 		flush_dcache_range((ulong)data->src,
255 				   (ulong)data->src+data->blocks
256 					 *data->blocksize);
257 #endif
258 		if (wml_value > WML_WR_WML_MAX)
259 			wml_value = WML_WR_WML_MAX_VAL;
260 		if (priv->wp_enable) {
261 			if ((esdhc_read32(&regs->prsstat) &
262 			    PRSSTAT_WPSPL) == 0) {
263 				printf("\nThe SD card is locked. Can not write to a locked card.\n\n");
264 				return -ETIMEDOUT;
265 			}
266 		}
267 
268 		esdhc_clrsetbits32(&regs->wml, WML_WR_WML_MASK,
269 					wml_value << 16);
270 #ifndef CONFIG_SYS_FSL_ESDHC_USE_PIO
271 #if defined(CONFIG_FSL_LAYERSCAPE) || defined(CONFIG_S32V234)
272 		addr = virt_to_phys((void *)(data->src));
273 		if (upper_32_bits(addr))
274 			printf("Error found for upper 32 bits\n");
275 		else
276 			esdhc_write32(&regs->dsaddr, lower_32_bits(addr));
277 #else
278 		esdhc_write32(&regs->dsaddr, (u32)data->src);
279 #endif
280 #endif
281 	}
282 
283 	esdhc_write32(&regs->blkattr, data->blocks << 16 | data->blocksize);
284 
285 	/* Calculate the timeout period for data transactions */
286 	/*
287 	 * 1)Timeout period = (2^(timeout+13)) SD Clock cycles
288 	 * 2)Timeout period should be minimum 0.250sec as per SD Card spec
289 	 *  So, Number of SD Clock cycles for 0.25sec should be minimum
290 	 *		(SD Clock/sec * 0.25 sec) SD Clock cycles
291 	 *		= (mmc->clock * 1/4) SD Clock cycles
292 	 * As 1) >=  2)
293 	 * => (2^(timeout+13)) >= mmc->clock * 1/4
294 	 * Taking log2 both the sides
295 	 * => timeout + 13 >= log2(mmc->clock/4)
296 	 * Rounding up to next power of 2
297 	 * => timeout + 13 = log2(mmc->clock/4) + 1
298 	 * => timeout + 13 = fls(mmc->clock/4)
299 	 *
300 	 * However, the MMC spec "It is strongly recommended for hosts to
301 	 * implement more than 500ms timeout value even if the card
302 	 * indicates the 250ms maximum busy length."  Even the previous
303 	 * value of 300ms is known to be insufficient for some cards.
304 	 * So, we use
305 	 * => timeout + 13 = fls(mmc->clock/2)
306 	 */
307 	timeout = fls(mmc->clock/2);
308 	timeout -= 13;
309 
310 	if (timeout > 14)
311 		timeout = 14;
312 
313 	if (timeout < 0)
314 		timeout = 0;
315 
316 #ifdef CONFIG_SYS_FSL_ERRATUM_ESDHC_A001
317 	if ((timeout == 4) || (timeout == 8) || (timeout == 12))
318 		timeout++;
319 #endif
320 
321 #ifdef ESDHCI_QUIRK_BROKEN_TIMEOUT_VALUE
322 	timeout = 0xE;
323 #endif
324 	esdhc_clrsetbits32(&regs->sysctl, SYSCTL_TIMEOUT_MASK, timeout << 16);
325 
326 	return 0;
327 }
328 
329 static void check_and_invalidate_dcache_range
330 	(struct mmc_cmd *cmd,
331 	 struct mmc_data *data) {
332 	unsigned start = 0;
333 	unsigned end = 0;
334 	unsigned size = roundup(ARCH_DMA_MINALIGN,
335 				data->blocks*data->blocksize);
336 #if defined(CONFIG_FSL_LAYERSCAPE) || defined(CONFIG_S32V234)
337 	dma_addr_t addr;
338 
339 	addr = virt_to_phys((void *)(data->dest));
340 	if (upper_32_bits(addr))
341 		printf("Error found for upper 32 bits\n");
342 	else
343 		start = lower_32_bits(addr);
344 #else
345 	start = (unsigned)data->dest;
346 #endif
347 	end = start + size;
348 	invalidate_dcache_range(start, end);
349 }
350 
351 /*
352  * Sends a command out on the bus.  Takes the mmc pointer,
353  * a command pointer, and an optional data pointer.
354  */
355 static int esdhc_send_cmd_common(struct fsl_esdhc_priv *priv, struct mmc *mmc,
356 				 struct mmc_cmd *cmd, struct mmc_data *data)
357 {
358 	int	err = 0;
359 	uint	xfertyp;
360 	uint	irqstat;
361 	struct fsl_esdhc *regs = priv->esdhc_regs;
362 
363 #ifdef CONFIG_SYS_FSL_ERRATUM_ESDHC111
364 	if (cmd->cmdidx == MMC_CMD_STOP_TRANSMISSION)
365 		return 0;
366 #endif
367 
368 	esdhc_write32(&regs->irqstat, -1);
369 
370 	sync();
371 
372 	/* Wait for the bus to be idle */
373 	while ((esdhc_read32(&regs->prsstat) & PRSSTAT_CICHB) ||
374 			(esdhc_read32(&regs->prsstat) & PRSSTAT_CIDHB))
375 		;
376 
377 	while (esdhc_read32(&regs->prsstat) & PRSSTAT_DLA)
378 		;
379 
380 	/* Wait at least 8 SD clock cycles before the next command */
381 	/*
382 	 * Note: This is way more than 8 cycles, but 1ms seems to
383 	 * resolve timing issues with some cards
384 	 */
385 	udelay(1000);
386 
387 	/* Set up for a data transfer if we have one */
388 	if (data) {
389 		err = esdhc_setup_data(priv, mmc, data);
390 		if(err)
391 			return err;
392 
393 		if (data->flags & MMC_DATA_READ)
394 			check_and_invalidate_dcache_range(cmd, data);
395 	}
396 
397 	/* Figure out the transfer arguments */
398 	xfertyp = esdhc_xfertyp(cmd, data);
399 
400 	/* Mask all irqs */
401 	esdhc_write32(&regs->irqsigen, 0);
402 
403 	/* Send the command */
404 	esdhc_write32(&regs->cmdarg, cmd->cmdarg);
405 #if defined(CONFIG_FSL_USDHC)
406 	esdhc_write32(&regs->mixctrl,
407 	(esdhc_read32(&regs->mixctrl) & 0xFFFFFF80) | (xfertyp & 0x7F)
408 			| (mmc->ddr_mode ? XFERTYP_DDREN : 0));
409 	esdhc_write32(&regs->xfertyp, xfertyp & 0xFFFF0000);
410 #else
411 	esdhc_write32(&regs->xfertyp, xfertyp);
412 #endif
413 
414 	/* Wait for the command to complete */
415 	while (!(esdhc_read32(&regs->irqstat) & (IRQSTAT_CC | IRQSTAT_CTOE)))
416 		;
417 
418 	irqstat = esdhc_read32(&regs->irqstat);
419 
420 	if (irqstat & CMD_ERR) {
421 		err = -ECOMM;
422 		goto out;
423 	}
424 
425 	if (irqstat & IRQSTAT_CTOE) {
426 		err = -ETIMEDOUT;
427 		goto out;
428 	}
429 
430 	/* Switch voltage to 1.8V if CMD11 succeeded */
431 	if (cmd->cmdidx == SD_CMD_SWITCH_UHS18V) {
432 		esdhc_setbits32(&regs->vendorspec, ESDHC_VENDORSPEC_VSELECT);
433 
434 		printf("Run CMD11 1.8V switch\n");
435 		/* Sleep for 5 ms - max time for card to switch to 1.8V */
436 		udelay(5000);
437 	}
438 
439 	/* Workaround for ESDHC errata ENGcm03648 */
440 	if (!data && (cmd->resp_type & MMC_RSP_BUSY)) {
441 		int timeout = 6000;
442 
443 		/* Poll on DATA0 line for cmd with busy signal for 600 ms */
444 		while (timeout > 0 && !(esdhc_read32(&regs->prsstat) &
445 					PRSSTAT_DAT0)) {
446 			udelay(100);
447 			timeout--;
448 		}
449 
450 		if (timeout <= 0) {
451 			printf("Timeout waiting for DAT0 to go high!\n");
452 			err = -ETIMEDOUT;
453 			goto out;
454 		}
455 	}
456 
457 	/* Copy the response to the response buffer */
458 	if (cmd->resp_type & MMC_RSP_136) {
459 		u32 cmdrsp3, cmdrsp2, cmdrsp1, cmdrsp0;
460 
461 		cmdrsp3 = esdhc_read32(&regs->cmdrsp3);
462 		cmdrsp2 = esdhc_read32(&regs->cmdrsp2);
463 		cmdrsp1 = esdhc_read32(&regs->cmdrsp1);
464 		cmdrsp0 = esdhc_read32(&regs->cmdrsp0);
465 		cmd->response[0] = (cmdrsp3 << 8) | (cmdrsp2 >> 24);
466 		cmd->response[1] = (cmdrsp2 << 8) | (cmdrsp1 >> 24);
467 		cmd->response[2] = (cmdrsp1 << 8) | (cmdrsp0 >> 24);
468 		cmd->response[3] = (cmdrsp0 << 8);
469 	} else
470 		cmd->response[0] = esdhc_read32(&regs->cmdrsp0);
471 
472 	/* Wait until all of the blocks are transferred */
473 	if (data) {
474 #ifdef CONFIG_SYS_FSL_ESDHC_USE_PIO
475 		esdhc_pio_read_write(priv, data);
476 #else
477 		do {
478 			irqstat = esdhc_read32(&regs->irqstat);
479 
480 			if (irqstat & IRQSTAT_DTOE) {
481 				err = -ETIMEDOUT;
482 				goto out;
483 			}
484 
485 			if (irqstat & DATA_ERR) {
486 				err = -ECOMM;
487 				goto out;
488 			}
489 		} while ((irqstat & DATA_COMPLETE) != DATA_COMPLETE);
490 
491 		/*
492 		 * Need invalidate the dcache here again to avoid any
493 		 * cache-fill during the DMA operations such as the
494 		 * speculative pre-fetching etc.
495 		 */
496 		if (data->flags & MMC_DATA_READ)
497 			check_and_invalidate_dcache_range(cmd, data);
498 #endif
499 	}
500 
501 out:
502 	/* Reset CMD and DATA portions on error */
503 	if (err) {
504 		esdhc_write32(&regs->sysctl, esdhc_read32(&regs->sysctl) |
505 			      SYSCTL_RSTC);
506 		while (esdhc_read32(&regs->sysctl) & SYSCTL_RSTC)
507 			;
508 
509 		if (data) {
510 			esdhc_write32(&regs->sysctl,
511 				      esdhc_read32(&regs->sysctl) |
512 				      SYSCTL_RSTD);
513 			while ((esdhc_read32(&regs->sysctl) & SYSCTL_RSTD))
514 				;
515 		}
516 
517 		/* If this was CMD11, then notify that power cycle is needed */
518 		if (cmd->cmdidx == SD_CMD_SWITCH_UHS18V)
519 			printf("CMD11 to switch to 1.8V mode failed, card requires power cycle.\n");
520 	}
521 
522 	esdhc_write32(&regs->irqstat, -1);
523 
524 	return err;
525 }
526 
527 static void set_sysctl(struct fsl_esdhc_priv *priv, struct mmc *mmc, uint clock)
528 {
529 	int div = 1;
530 #ifdef ARCH_MXC
531 	int pre_div = 1;
532 #else
533 	int pre_div = 2;
534 #endif
535 	int ddr_pre_div = mmc->ddr_mode ? 2 : 1;
536 	struct fsl_esdhc *regs = priv->esdhc_regs;
537 	int sdhc_clk = priv->sdhc_clk;
538 	uint clk;
539 
540 	if (clock < mmc->cfg->f_min)
541 		clock = mmc->cfg->f_min;
542 
543 	while (sdhc_clk / (16 * pre_div * ddr_pre_div) > clock && pre_div < 256)
544 		pre_div *= 2;
545 
546 	while (sdhc_clk / (div * pre_div * ddr_pre_div) > clock && div < 16)
547 		div++;
548 
549 	pre_div >>= 1;
550 	div -= 1;
551 
552 	clk = (pre_div << 8) | (div << 4);
553 
554 #ifdef CONFIG_FSL_USDHC
555 	esdhc_clrbits32(&regs->vendorspec, VENDORSPEC_CKEN);
556 #else
557 	esdhc_clrbits32(&regs->sysctl, SYSCTL_CKEN);
558 #endif
559 
560 	esdhc_clrsetbits32(&regs->sysctl, SYSCTL_CLOCK_MASK, clk);
561 
562 	udelay(10000);
563 
564 #ifdef CONFIG_FSL_USDHC
565 	esdhc_setbits32(&regs->vendorspec, VENDORSPEC_PEREN | VENDORSPEC_CKEN);
566 #else
567 	esdhc_setbits32(&regs->sysctl, SYSCTL_PEREN | SYSCTL_CKEN);
568 #endif
569 
570 }
571 
572 #ifdef CONFIG_FSL_ESDHC_USE_PERIPHERAL_CLK
573 static void esdhc_clock_control(struct fsl_esdhc_priv *priv, bool enable)
574 {
575 	struct fsl_esdhc *regs = priv->esdhc_regs;
576 	u32 value;
577 	u32 time_out;
578 
579 	value = esdhc_read32(&regs->sysctl);
580 
581 	if (enable)
582 		value |= SYSCTL_CKEN;
583 	else
584 		value &= ~SYSCTL_CKEN;
585 
586 	esdhc_write32(&regs->sysctl, value);
587 
588 	time_out = 20;
589 	value = PRSSTAT_SDSTB;
590 	while (!(esdhc_read32(&regs->prsstat) & value)) {
591 		if (time_out == 0) {
592 			printf("fsl_esdhc: Internal clock never stabilised.\n");
593 			break;
594 		}
595 		time_out--;
596 		mdelay(1);
597 	}
598 }
599 #endif
600 
601 static int esdhc_set_ios_common(struct fsl_esdhc_priv *priv, struct mmc *mmc)
602 {
603 	struct fsl_esdhc *regs = priv->esdhc_regs;
604 
605 #ifdef CONFIG_FSL_ESDHC_USE_PERIPHERAL_CLK
606 	/* Select to use peripheral clock */
607 	esdhc_clock_control(priv, false);
608 	esdhc_setbits32(&regs->scr, ESDHCCTL_PCS);
609 	esdhc_clock_control(priv, true);
610 #endif
611 	/* Set the clock speed */
612 	set_sysctl(priv, mmc, mmc->clock);
613 
614 	/* Set the bus width */
615 	esdhc_clrbits32(&regs->proctl, PROCTL_DTW_4 | PROCTL_DTW_8);
616 
617 	if (mmc->bus_width == 4)
618 		esdhc_setbits32(&regs->proctl, PROCTL_DTW_4);
619 	else if (mmc->bus_width == 8)
620 		esdhc_setbits32(&regs->proctl, PROCTL_DTW_8);
621 
622 	return 0;
623 }
624 
625 static int esdhc_init_common(struct fsl_esdhc_priv *priv, struct mmc *mmc)
626 {
627 	struct fsl_esdhc *regs = priv->esdhc_regs;
628 	ulong start;
629 
630 	/* Reset the entire host controller */
631 	esdhc_setbits32(&regs->sysctl, SYSCTL_RSTA);
632 
633 	/* Wait until the controller is available */
634 	start = get_timer(0);
635 	while ((esdhc_read32(&regs->sysctl) & SYSCTL_RSTA)) {
636 		if (get_timer(start) > 1000)
637 			return -ETIMEDOUT;
638 	}
639 
640 #if defined(CONFIG_FSL_USDHC)
641 	/* RSTA doesn't reset MMC_BOOT register, so manually reset it */
642 	esdhc_write32(&regs->mmcboot, 0x0);
643 	/* Reset MIX_CTRL and CLK_TUNE_CTRL_STATUS regs to 0 */
644 	esdhc_write32(&regs->mixctrl, 0x0);
645 	esdhc_write32(&regs->clktunectrlstatus, 0x0);
646 
647 	/* Put VEND_SPEC to default value */
648 	esdhc_write32(&regs->vendorspec, VENDORSPEC_INIT);
649 
650 	/* Disable DLL_CTRL delay line */
651 	esdhc_write32(&regs->dllctrl, 0x0);
652 #endif
653 
654 #ifndef ARCH_MXC
655 	/* Enable cache snooping */
656 	esdhc_write32(&regs->scr, 0x00000040);
657 #endif
658 
659 #ifndef CONFIG_FSL_USDHC
660 	esdhc_setbits32(&regs->sysctl, SYSCTL_HCKEN | SYSCTL_IPGEN);
661 #else
662 	esdhc_setbits32(&regs->vendorspec, VENDORSPEC_HCKEN | VENDORSPEC_IPGEN);
663 #endif
664 
665 	/* Set the initial clock speed */
666 	mmc_set_clock(mmc, 400000);
667 
668 	/* Disable the BRR and BWR bits in IRQSTAT */
669 	esdhc_clrbits32(&regs->irqstaten, IRQSTATEN_BRR | IRQSTATEN_BWR);
670 
671 	/* Put the PROCTL reg back to the default */
672 	esdhc_write32(&regs->proctl, PROCTL_INIT);
673 
674 	/* Set timout to the maximum value */
675 	esdhc_clrsetbits32(&regs->sysctl, SYSCTL_TIMEOUT_MASK, 14 << 16);
676 
677 	if (priv->vs18_enable)
678 		esdhc_setbits32(&regs->vendorspec, ESDHC_VENDORSPEC_VSELECT);
679 
680 	return 0;
681 }
682 
683 static int esdhc_getcd_common(struct fsl_esdhc_priv *priv)
684 {
685 	struct fsl_esdhc *regs = priv->esdhc_regs;
686 	int timeout = 1000;
687 
688 #ifdef CONFIG_ESDHC_DETECT_QUIRK
689 	if (CONFIG_ESDHC_DETECT_QUIRK)
690 		return 1;
691 #endif
692 
693 #ifdef CONFIG_DM_MMC
694 	if (priv->non_removable)
695 		return 1;
696 #ifdef CONFIG_DM_GPIO
697 	if (dm_gpio_is_valid(&priv->cd_gpio))
698 		return dm_gpio_get_value(&priv->cd_gpio);
699 #endif
700 #endif
701 
702 	while (!(esdhc_read32(&regs->prsstat) & PRSSTAT_CINS) && --timeout)
703 		udelay(1000);
704 
705 	return timeout > 0;
706 }
707 
708 static int esdhc_reset(struct fsl_esdhc *regs)
709 {
710 	ulong start;
711 
712 	/* reset the controller */
713 	esdhc_setbits32(&regs->sysctl, SYSCTL_RSTA);
714 
715 	/* hardware clears the bit when it is done */
716 	start = get_timer(0);
717 	while ((esdhc_read32(&regs->sysctl) & SYSCTL_RSTA)) {
718 		if (get_timer(start) > 100) {
719 			printf("MMC/SD: Reset never completed.\n");
720 			return -ETIMEDOUT;
721 		}
722 	}
723 
724 	return 0;
725 }
726 
727 static int esdhc_getcd(struct mmc *mmc)
728 {
729 	struct fsl_esdhc_priv *priv = mmc->priv;
730 
731 	return esdhc_getcd_common(priv);
732 }
733 
734 static int esdhc_init(struct mmc *mmc)
735 {
736 	struct fsl_esdhc_priv *priv = mmc->priv;
737 
738 	return esdhc_init_common(priv, mmc);
739 }
740 
741 static int esdhc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd,
742 			  struct mmc_data *data)
743 {
744 	struct fsl_esdhc_priv *priv = mmc->priv;
745 
746 	return esdhc_send_cmd_common(priv, mmc, cmd, data);
747 }
748 
749 static int esdhc_set_ios(struct mmc *mmc)
750 {
751 	struct fsl_esdhc_priv *priv = mmc->priv;
752 
753 	return esdhc_set_ios_common(priv, mmc);
754 }
755 
756 static const struct mmc_ops esdhc_ops = {
757 	.getcd		= esdhc_getcd,
758 	.init		= esdhc_init,
759 	.send_cmd	= esdhc_send_cmd,
760 	.set_ios	= esdhc_set_ios,
761 };
762 
763 static int fsl_esdhc_init(struct fsl_esdhc_priv *priv,
764 			  struct fsl_esdhc_plat *plat)
765 {
766 	struct mmc_config *cfg;
767 	struct fsl_esdhc *regs;
768 	u32 caps, voltage_caps;
769 	int ret;
770 
771 	if (!priv)
772 		return -EINVAL;
773 
774 	regs = priv->esdhc_regs;
775 
776 	/* First reset the eSDHC controller */
777 	ret = esdhc_reset(regs);
778 	if (ret)
779 		return ret;
780 
781 #ifndef CONFIG_FSL_USDHC
782 	esdhc_setbits32(&regs->sysctl, SYSCTL_PEREN | SYSCTL_HCKEN
783 				| SYSCTL_IPGEN | SYSCTL_CKEN);
784 #else
785 	esdhc_setbits32(&regs->vendorspec, VENDORSPEC_PEREN |
786 			VENDORSPEC_HCKEN | VENDORSPEC_IPGEN | VENDORSPEC_CKEN);
787 #endif
788 
789 	if (priv->vs18_enable)
790 		esdhc_setbits32(&regs->vendorspec, ESDHC_VENDORSPEC_VSELECT);
791 
792 	writel(SDHCI_IRQ_EN_BITS, &regs->irqstaten);
793 	cfg = &plat->cfg;
794 	memset(cfg, '\0', sizeof(*cfg));
795 
796 	voltage_caps = 0;
797 	caps = esdhc_read32(&regs->hostcapblt);
798 
799 #ifdef CONFIG_SYS_FSL_ERRATUM_ESDHC135
800 	caps = caps & ~(ESDHC_HOSTCAPBLT_SRS |
801 			ESDHC_HOSTCAPBLT_VS18 | ESDHC_HOSTCAPBLT_VS30);
802 #endif
803 
804 /* T4240 host controller capabilities register should have VS33 bit */
805 #ifdef CONFIG_SYS_FSL_MMC_HAS_CAPBLT_VS33
806 	caps = caps | ESDHC_HOSTCAPBLT_VS33;
807 #endif
808 
809 	if (caps & ESDHC_HOSTCAPBLT_VS18)
810 		voltage_caps |= MMC_VDD_165_195;
811 	if (caps & ESDHC_HOSTCAPBLT_VS30)
812 		voltage_caps |= MMC_VDD_29_30 | MMC_VDD_30_31;
813 	if (caps & ESDHC_HOSTCAPBLT_VS33)
814 		voltage_caps |= MMC_VDD_32_33 | MMC_VDD_33_34;
815 
816 	cfg->name = "FSL_SDHC";
817 	cfg->ops = &esdhc_ops;
818 #ifdef CONFIG_SYS_SD_VOLTAGE
819 	cfg->voltages = CONFIG_SYS_SD_VOLTAGE;
820 #else
821 	cfg->voltages = MMC_VDD_32_33 | MMC_VDD_33_34;
822 #endif
823 	if ((cfg->voltages & voltage_caps) == 0) {
824 		printf("voltage not supported by controller\n");
825 		return -1;
826 	}
827 
828 	if (priv->bus_width == 8)
829 		cfg->host_caps = MMC_MODE_4BIT | MMC_MODE_8BIT;
830 	else if (priv->bus_width == 4)
831 		cfg->host_caps = MMC_MODE_4BIT;
832 
833 	cfg->host_caps = MMC_MODE_4BIT | MMC_MODE_8BIT;
834 #ifdef CONFIG_SYS_FSL_ESDHC_HAS_DDR_MODE
835 	cfg->host_caps |= MMC_MODE_DDR_52MHz;
836 #endif
837 
838 	if (priv->bus_width > 0) {
839 		if (priv->bus_width < 8)
840 			cfg->host_caps &= ~MMC_MODE_8BIT;
841 		if (priv->bus_width < 4)
842 			cfg->host_caps &= ~MMC_MODE_4BIT;
843 	}
844 
845 	if (caps & ESDHC_HOSTCAPBLT_HSS)
846 		cfg->host_caps |= MMC_MODE_HS_52MHz | MMC_MODE_HS;
847 
848 #ifdef CONFIG_ESDHC_DETECT_8_BIT_QUIRK
849 	if (CONFIG_ESDHC_DETECT_8_BIT_QUIRK)
850 		cfg->host_caps &= ~MMC_MODE_8BIT;
851 #endif
852 
853 	cfg->f_min = 400000;
854 	cfg->f_max = min(priv->sdhc_clk, (u32)52000000);
855 
856 	cfg->b_max = CONFIG_SYS_MMC_MAX_BLK_COUNT;
857 
858 	return 0;
859 }
860 
861 #ifndef CONFIG_DM_MMC
862 static int fsl_esdhc_cfg_to_priv(struct fsl_esdhc_cfg *cfg,
863 				 struct fsl_esdhc_priv *priv)
864 {
865 	if (!cfg || !priv)
866 		return -EINVAL;
867 
868 	priv->esdhc_regs = (struct fsl_esdhc *)(unsigned long)(cfg->esdhc_base);
869 	priv->bus_width = cfg->max_bus_width;
870 	priv->sdhc_clk = cfg->sdhc_clk;
871 	priv->wp_enable  = cfg->wp_enable;
872 	priv->vs18_enable  = cfg->vs18_enable;
873 
874 	return 0;
875 };
876 
877 int fsl_esdhc_initialize(bd_t *bis, struct fsl_esdhc_cfg *cfg)
878 {
879 	struct fsl_esdhc_plat *plat;
880 	struct fsl_esdhc_priv *priv;
881 	struct mmc *mmc;
882 	int ret;
883 
884 	if (!cfg)
885 		return -EINVAL;
886 
887 	priv = calloc(sizeof(struct fsl_esdhc_priv), 1);
888 	if (!priv)
889 		return -ENOMEM;
890 	plat = calloc(sizeof(struct fsl_esdhc_plat), 1);
891 	if (!plat) {
892 		free(priv);
893 		return -ENOMEM;
894 	}
895 
896 	ret = fsl_esdhc_cfg_to_priv(cfg, priv);
897 	if (ret) {
898 		debug("%s xlate failure\n", __func__);
899 		free(plat);
900 		free(priv);
901 		return ret;
902 	}
903 
904 	ret = fsl_esdhc_init(priv, plat);
905 	if (ret) {
906 		debug("%s init failure\n", __func__);
907 		free(plat);
908 		free(priv);
909 		return ret;
910 	}
911 
912 	mmc = mmc_create(&plat->cfg, priv);
913 	if (!mmc)
914 		return -EIO;
915 
916 	priv->mmc = mmc;
917 
918 	return 0;
919 }
920 
921 int fsl_esdhc_mmc_init(bd_t *bis)
922 {
923 	struct fsl_esdhc_cfg *cfg;
924 
925 	cfg = calloc(sizeof(struct fsl_esdhc_cfg), 1);
926 	cfg->esdhc_base = CONFIG_SYS_FSL_ESDHC_ADDR;
927 	cfg->sdhc_clk = gd->arch.sdhc_clk;
928 	return fsl_esdhc_initialize(bis, cfg);
929 }
930 #endif
931 
932 #ifdef CONFIG_FSL_ESDHC_ADAPTER_IDENT
933 void mmc_adapter_card_type_ident(void)
934 {
935 	u8 card_id;
936 	u8 value;
937 
938 	card_id = QIXIS_READ(present) & QIXIS_SDID_MASK;
939 	gd->arch.sdhc_adapter = card_id;
940 
941 	switch (card_id) {
942 	case QIXIS_ESDHC_ADAPTER_TYPE_EMMC45:
943 		value = QIXIS_READ(brdcfg[5]);
944 		value |= (QIXIS_DAT4 | QIXIS_DAT5_6_7);
945 		QIXIS_WRITE(brdcfg[5], value);
946 		break;
947 	case QIXIS_ESDHC_ADAPTER_TYPE_SDMMC_LEGACY:
948 		value = QIXIS_READ(pwr_ctl[1]);
949 		value |= QIXIS_EVDD_BY_SDHC_VS;
950 		QIXIS_WRITE(pwr_ctl[1], value);
951 		break;
952 	case QIXIS_ESDHC_ADAPTER_TYPE_EMMC44:
953 		value = QIXIS_READ(brdcfg[5]);
954 		value |= (QIXIS_SDCLKIN | QIXIS_SDCLKOUT);
955 		QIXIS_WRITE(brdcfg[5], value);
956 		break;
957 	case QIXIS_ESDHC_ADAPTER_TYPE_RSV:
958 		break;
959 	case QIXIS_ESDHC_ADAPTER_TYPE_MMC:
960 		break;
961 	case QIXIS_ESDHC_ADAPTER_TYPE_SD:
962 		break;
963 	case QIXIS_ESDHC_NO_ADAPTER:
964 		break;
965 	default:
966 		break;
967 	}
968 }
969 #endif
970 
971 #ifdef CONFIG_OF_LIBFDT
972 __weak int esdhc_status_fixup(void *blob, const char *compat)
973 {
974 #ifdef CONFIG_FSL_ESDHC_PIN_MUX
975 	if (!hwconfig("esdhc")) {
976 		do_fixup_by_compat(blob, compat, "status", "disabled",
977 				sizeof("disabled"), 1);
978 		return 1;
979 	}
980 #endif
981 	return 0;
982 }
983 
984 void fdt_fixup_esdhc(void *blob, bd_t *bd)
985 {
986 	const char *compat = "fsl,esdhc";
987 
988 	if (esdhc_status_fixup(blob, compat))
989 		return;
990 
991 #ifdef CONFIG_FSL_ESDHC_USE_PERIPHERAL_CLK
992 	do_fixup_by_compat_u32(blob, compat, "peripheral-frequency",
993 			       gd->arch.sdhc_clk, 1);
994 #else
995 	do_fixup_by_compat_u32(blob, compat, "clock-frequency",
996 			       gd->arch.sdhc_clk, 1);
997 #endif
998 #ifdef CONFIG_FSL_ESDHC_ADAPTER_IDENT
999 	do_fixup_by_compat_u32(blob, compat, "adapter-type",
1000 			       (u32)(gd->arch.sdhc_adapter), 1);
1001 #endif
1002 }
1003 #endif
1004 
1005 #ifdef CONFIG_DM_MMC
1006 #include <asm/arch/clock.h>
1007 __weak void init_clk_usdhc(u32 index)
1008 {
1009 }
1010 
1011 static int fsl_esdhc_probe(struct udevice *dev)
1012 {
1013 	struct mmc_uclass_priv *upriv = dev_get_uclass_priv(dev);
1014 	struct fsl_esdhc_plat *plat = dev_get_platdata(dev);
1015 	struct fsl_esdhc_priv *priv = dev_get_priv(dev);
1016 	const void *fdt = gd->fdt_blob;
1017 	int node = dev_of_offset(dev);
1018 #ifdef CONFIG_DM_REGULATOR
1019 	struct udevice *vqmmc_dev;
1020 #endif
1021 	fdt_addr_t addr;
1022 	unsigned int val;
1023 	int ret;
1024 
1025 	addr = devfdt_get_addr(dev);
1026 	if (addr == FDT_ADDR_T_NONE)
1027 		return -EINVAL;
1028 
1029 	priv->esdhc_regs = (struct fsl_esdhc *)addr;
1030 	priv->dev = dev;
1031 
1032 	val = fdtdec_get_int(fdt, node, "bus-width", -1);
1033 	if (val == 8)
1034 		priv->bus_width = 8;
1035 	else if (val == 4)
1036 		priv->bus_width = 4;
1037 	else
1038 		priv->bus_width = 1;
1039 
1040 	if (fdt_get_property(fdt, node, "non-removable", NULL)) {
1041 		priv->non_removable = 1;
1042 	 } else {
1043 		priv->non_removable = 0;
1044 #ifdef CONFIG_DM_GPIO
1045 		gpio_request_by_name_nodev(offset_to_ofnode(node), "cd-gpios",
1046 					   0, &priv->cd_gpio, GPIOD_IS_IN);
1047 #endif
1048 	}
1049 
1050 	priv->wp_enable = 1;
1051 
1052 #ifdef CONFIG_DM_GPIO
1053 	ret = gpio_request_by_name_nodev(offset_to_ofnode(node), "wp-gpios", 0,
1054 					 &priv->wp_gpio, GPIOD_IS_IN);
1055 	if (ret)
1056 		priv->wp_enable = 0;
1057 #endif
1058 
1059 	priv->vs18_enable = 0;
1060 
1061 #ifdef CONFIG_DM_REGULATOR
1062 	/*
1063 	 * If emmc I/O has a fixed voltage at 1.8V, this must be provided,
1064 	 * otherwise, emmc will work abnormally.
1065 	 */
1066 	ret = device_get_supply_regulator(dev, "vqmmc-supply", &vqmmc_dev);
1067 	if (ret) {
1068 		dev_dbg(dev, "no vqmmc-supply\n");
1069 	} else {
1070 		ret = regulator_set_enable(vqmmc_dev, true);
1071 		if (ret) {
1072 			dev_err(dev, "fail to enable vqmmc-supply\n");
1073 			return ret;
1074 		}
1075 
1076 		if (regulator_get_value(vqmmc_dev) == 1800000)
1077 			priv->vs18_enable = 1;
1078 	}
1079 #endif
1080 
1081 	/*
1082 	 * TODO:
1083 	 * Because lack of clk driver, if SDHC clk is not enabled,
1084 	 * need to enable it first before this driver is invoked.
1085 	 *
1086 	 * we use MXC_ESDHC_CLK to get clk freq.
1087 	 * If one would like to make this function work,
1088 	 * the aliases should be provided in dts as this:
1089 	 *
1090 	 *  aliases {
1091 	 *	mmc0 = &usdhc1;
1092 	 *	mmc1 = &usdhc2;
1093 	 *	mmc2 = &usdhc3;
1094 	 *	mmc3 = &usdhc4;
1095 	 *	};
1096 	 * Then if your board only supports mmc2 and mmc3, but we can
1097 	 * correctly get the seq as 2 and 3, then let mxc_get_clock
1098 	 * work as expected.
1099 	 */
1100 
1101 	init_clk_usdhc(dev->seq);
1102 
1103 	priv->sdhc_clk = mxc_get_clock(MXC_ESDHC_CLK + dev->seq);
1104 	if (priv->sdhc_clk <= 0) {
1105 		dev_err(dev, "Unable to get clk for %s\n", dev->name);
1106 		return -EINVAL;
1107 	}
1108 
1109 	ret = fsl_esdhc_init(priv, plat);
1110 	if (ret) {
1111 		dev_err(dev, "fsl_esdhc_init failure\n");
1112 		return ret;
1113 	}
1114 
1115 	upriv->mmc = priv->mmc;
1116 	priv->mmc->dev = dev;
1117 
1118 	return 0;
1119 }
1120 
1121 static const struct udevice_id fsl_esdhc_ids[] = {
1122 	{ .compatible = "fsl,imx6ul-usdhc", },
1123 	{ .compatible = "fsl,imx6sx-usdhc", },
1124 	{ .compatible = "fsl,imx6sl-usdhc", },
1125 	{ .compatible = "fsl,imx6q-usdhc", },
1126 	{ .compatible = "fsl,imx7d-usdhc", },
1127 	{ .compatible = "fsl,imx7ulp-usdhc", },
1128 	{ .compatible = "fsl,esdhc", },
1129 	{ /* sentinel */ }
1130 };
1131 
1132 U_BOOT_DRIVER(fsl_esdhc) = {
1133 	.name	= "fsl-esdhc-mmc",
1134 	.id	= UCLASS_MMC,
1135 	.of_match = fsl_esdhc_ids,
1136 	.probe	= fsl_esdhc_probe,
1137 	.platdata_auto_alloc_size = sizeof(struct fsl_esdhc_plat),
1138 	.priv_auto_alloc_size = sizeof(struct fsl_esdhc_priv),
1139 };
1140 #endif
1141