xref: /openbmc/u-boot/drivers/mmc/fsl_esdhc.c (revision a8d954ba)
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  * See file CREDITS for list of people who contributed to this
10  * project.
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License as
14  * published by the Free Software Foundation; either version 2 of
15  * the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
25  * MA 02111-1307 USA
26  */
27 
28 #include <config.h>
29 #include <common.h>
30 #include <command.h>
31 #include <hwconfig.h>
32 #include <mmc.h>
33 #include <part.h>
34 #include <malloc.h>
35 #include <mmc.h>
36 #include <fsl_esdhc.h>
37 #include <fdt_support.h>
38 #include <asm/io.h>
39 
40 DECLARE_GLOBAL_DATA_PTR;
41 
42 struct fsl_esdhc {
43 	uint	dsaddr;
44 	uint	blkattr;
45 	uint	cmdarg;
46 	uint	xfertyp;
47 	uint	cmdrsp0;
48 	uint	cmdrsp1;
49 	uint	cmdrsp2;
50 	uint	cmdrsp3;
51 	uint	datport;
52 	uint	prsstat;
53 	uint	proctl;
54 	uint	sysctl;
55 	uint	irqstat;
56 	uint	irqstaten;
57 	uint	irqsigen;
58 	uint	autoc12err;
59 	uint	hostcapblt;
60 	uint	wml;
61 	char	reserved1[8];
62 	uint	fevt;
63 	char	reserved2[168];
64 	uint	hostver;
65 	char	reserved3[780];
66 	uint	scr;
67 };
68 
69 /* Return the XFERTYP flags for a given command and data packet */
70 uint esdhc_xfertyp(struct mmc_cmd *cmd, struct mmc_data *data)
71 {
72 	uint xfertyp = 0;
73 
74 	if (data) {
75 		xfertyp |= XFERTYP_DPSEL;
76 #ifndef CONFIG_SYS_FSL_ESDHC_USE_PIO
77 		xfertyp |= XFERTYP_DMAEN;
78 #endif
79 		if (data->blocks > 1) {
80 			xfertyp |= XFERTYP_MSBSEL;
81 			xfertyp |= XFERTYP_BCEN;
82 #ifdef CONFIG_SYS_FSL_ERRATUM_ESDHC111
83 			xfertyp |= XFERTYP_AC12EN;
84 #endif
85 		}
86 
87 		if (data->flags & MMC_DATA_READ)
88 			xfertyp |= XFERTYP_DTDSEL;
89 	}
90 
91 	if (cmd->resp_type & MMC_RSP_CRC)
92 		xfertyp |= XFERTYP_CCCEN;
93 	if (cmd->resp_type & MMC_RSP_OPCODE)
94 		xfertyp |= XFERTYP_CICEN;
95 	if (cmd->resp_type & MMC_RSP_136)
96 		xfertyp |= XFERTYP_RSPTYP_136;
97 	else if (cmd->resp_type & MMC_RSP_BUSY)
98 		xfertyp |= XFERTYP_RSPTYP_48_BUSY;
99 	else if (cmd->resp_type & MMC_RSP_PRESENT)
100 		xfertyp |= XFERTYP_RSPTYP_48;
101 
102 	return XFERTYP_CMD(cmd->cmdidx) | xfertyp;
103 }
104 
105 #ifdef CONFIG_SYS_FSL_ESDHC_USE_PIO
106 /*
107  * PIO Read/Write Mode reduce the performace as DMA is not used in this mode.
108  */
109 static void
110 esdhc_pio_read_write(struct mmc *mmc, struct mmc_data *data)
111 {
112 	struct fsl_esdhc *regs = mmc->priv;
113 	uint blocks;
114 	char *buffer;
115 	uint databuf;
116 	uint size;
117 	uint irqstat;
118 	uint timeout;
119 
120 	if (data->flags & MMC_DATA_READ) {
121 		blocks = data->blocks;
122 		buffer = data->dest;
123 		while (blocks) {
124 			timeout = PIO_TIMEOUT;
125 			size = data->blocksize;
126 			irqstat = esdhc_read32(&regs->irqstat);
127 			while (!(esdhc_read32(&regs->prsstat) & PRSSTAT_BREN)
128 				&& --timeout);
129 			if (timeout <= 0) {
130 				printf("\nData Read Failed in PIO Mode.");
131 				return;
132 			}
133 			while (size && (!(irqstat & IRQSTAT_TC))) {
134 				udelay(100); /* Wait before last byte transfer complete */
135 				irqstat = esdhc_read32(&regs->irqstat);
136 				databuf = in_le32(&regs->datport);
137 				*((uint *)buffer) = databuf;
138 				buffer += 4;
139 				size -= 4;
140 			}
141 			blocks--;
142 		}
143 	} else {
144 		blocks = data->blocks;
145 		buffer = (char *)data->src;
146 		while (blocks) {
147 			timeout = PIO_TIMEOUT;
148 			size = data->blocksize;
149 			irqstat = esdhc_read32(&regs->irqstat);
150 			while (!(esdhc_read32(&regs->prsstat) & PRSSTAT_BWEN)
151 				&& --timeout);
152 			if (timeout <= 0) {
153 				printf("\nData Write Failed in PIO Mode.");
154 				return;
155 			}
156 			while (size && (!(irqstat & IRQSTAT_TC))) {
157 				udelay(100); /* Wait before last byte transfer complete */
158 				databuf = *((uint *)buffer);
159 				buffer += 4;
160 				size -= 4;
161 				irqstat = esdhc_read32(&regs->irqstat);
162 				out_le32(&regs->datport, databuf);
163 			}
164 			blocks--;
165 		}
166 	}
167 }
168 #endif
169 
170 static int esdhc_setup_data(struct mmc *mmc, struct mmc_data *data)
171 {
172 	int timeout;
173 	struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
174 	struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
175 #ifndef CONFIG_SYS_FSL_ESDHC_USE_PIO
176 	uint wml_value;
177 
178 	wml_value = data->blocksize/4;
179 
180 	if (data->flags & MMC_DATA_READ) {
181 		if (wml_value > 0x10)
182 			wml_value = 0x10;
183 
184 		esdhc_clrsetbits32(&regs->wml, WML_RD_WML_MASK, wml_value);
185 		esdhc_write32(&regs->dsaddr, (u32)data->dest);
186 	} else {
187 		if (wml_value > 0x80)
188 			wml_value = 0x80;
189 		if ((esdhc_read32(&regs->prsstat) & PRSSTAT_WPSPL) == 0) {
190 			printf("\nThe SD card is locked. Can not write to a locked card.\n\n");
191 			return TIMEOUT;
192 		}
193 
194 		esdhc_clrsetbits32(&regs->wml, WML_WR_WML_MASK,
195 					wml_value << 16);
196 		esdhc_write32(&regs->dsaddr, (u32)data->src);
197 	}
198 #else	/* CONFIG_SYS_FSL_ESDHC_USE_PIO */
199 	if (!(data->flags & MMC_DATA_READ)) {
200 		if ((esdhc_read32(&regs->prsstat) & PRSSTAT_WPSPL) == 0) {
201 			printf("\nThe SD card is locked. "
202 				"Can not write to a locked card.\n\n");
203 			return TIMEOUT;
204 		}
205 		esdhc_write32(&regs->dsaddr, (u32)data->src);
206 	} else
207 		esdhc_write32(&regs->dsaddr, (u32)data->dest);
208 #endif	/* CONFIG_SYS_FSL_ESDHC_USE_PIO */
209 
210 	esdhc_write32(&regs->blkattr, data->blocks << 16 | data->blocksize);
211 
212 	/* Calculate the timeout period for data transactions */
213 	timeout = fls(mmc->tran_speed/10) - 1;
214 	timeout -= 13;
215 
216 	if (timeout > 14)
217 		timeout = 14;
218 
219 	if (timeout < 0)
220 		timeout = 0;
221 
222 	esdhc_clrsetbits32(&regs->sysctl, SYSCTL_TIMEOUT_MASK, timeout << 16);
223 
224 	return 0;
225 }
226 
227 
228 /*
229  * Sends a command out on the bus.  Takes the mmc pointer,
230  * a command pointer, and an optional data pointer.
231  */
232 static int
233 esdhc_send_cmd(struct mmc *mmc, struct mmc_cmd *cmd, struct mmc_data *data)
234 {
235 	uint	xfertyp;
236 	uint	irqstat;
237 	struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
238 	volatile struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
239 
240 #ifdef CONFIG_SYS_FSL_ERRATUM_ESDHC111
241 	if (cmd->cmdidx == MMC_CMD_STOP_TRANSMISSION)
242 		return 0;
243 #endif
244 
245 	esdhc_write32(&regs->irqstat, -1);
246 
247 	sync();
248 
249 	/* Wait for the bus to be idle */
250 	while ((esdhc_read32(&regs->prsstat) & PRSSTAT_CICHB) ||
251 			(esdhc_read32(&regs->prsstat) & PRSSTAT_CIDHB))
252 		;
253 
254 	while (esdhc_read32(&regs->prsstat) & PRSSTAT_DLA)
255 		;
256 
257 	/* Wait at least 8 SD clock cycles before the next command */
258 	/*
259 	 * Note: This is way more than 8 cycles, but 1ms seems to
260 	 * resolve timing issues with some cards
261 	 */
262 	udelay(1000);
263 
264 	/* Set up for a data transfer if we have one */
265 	if (data) {
266 		int err;
267 
268 		err = esdhc_setup_data(mmc, data);
269 		if(err)
270 			return err;
271 	}
272 
273 	/* Figure out the transfer arguments */
274 	xfertyp = esdhc_xfertyp(cmd, data);
275 
276 	/* Send the command */
277 	esdhc_write32(&regs->cmdarg, cmd->cmdarg);
278 	esdhc_write32(&regs->xfertyp, xfertyp);
279 
280 	/* Wait for the command to complete */
281 	while (!(esdhc_read32(&regs->irqstat) & IRQSTAT_CC))
282 		;
283 
284 	irqstat = esdhc_read32(&regs->irqstat);
285 	esdhc_write32(&regs->irqstat, irqstat);
286 
287 	if (irqstat & CMD_ERR)
288 		return COMM_ERR;
289 
290 	if (irqstat & IRQSTAT_CTOE)
291 		return TIMEOUT;
292 
293 	/* Copy the response to the response buffer */
294 	if (cmd->resp_type & MMC_RSP_136) {
295 		u32 cmdrsp3, cmdrsp2, cmdrsp1, cmdrsp0;
296 
297 		cmdrsp3 = esdhc_read32(&regs->cmdrsp3);
298 		cmdrsp2 = esdhc_read32(&regs->cmdrsp2);
299 		cmdrsp1 = esdhc_read32(&regs->cmdrsp1);
300 		cmdrsp0 = esdhc_read32(&regs->cmdrsp0);
301 		cmd->response[0] = (cmdrsp3 << 8) | (cmdrsp2 >> 24);
302 		cmd->response[1] = (cmdrsp2 << 8) | (cmdrsp1 >> 24);
303 		cmd->response[2] = (cmdrsp1 << 8) | (cmdrsp0 >> 24);
304 		cmd->response[3] = (cmdrsp0 << 8);
305 	} else
306 		cmd->response[0] = esdhc_read32(&regs->cmdrsp0);
307 
308 	/* Wait until all of the blocks are transferred */
309 	if (data) {
310 #ifdef CONFIG_SYS_FSL_ESDHC_USE_PIO
311 		esdhc_pio_read_write(mmc, data);
312 #else
313 		do {
314 			irqstat = esdhc_read32(&regs->irqstat);
315 
316 			if (irqstat & DATA_ERR)
317 				return COMM_ERR;
318 
319 			if (irqstat & IRQSTAT_DTOE)
320 				return TIMEOUT;
321 		} while (!(irqstat & IRQSTAT_TC) &&
322 				(esdhc_read32(&regs->prsstat) & PRSSTAT_DLA));
323 #endif
324 	}
325 
326 	esdhc_write32(&regs->irqstat, -1);
327 
328 	return 0;
329 }
330 
331 void set_sysctl(struct mmc *mmc, uint clock)
332 {
333 	int sdhc_clk = gd->sdhc_clk;
334 	int div, pre_div;
335 	struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
336 	volatile struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
337 	uint clk;
338 
339 	if (clock < mmc->f_min)
340 		clock = mmc->f_min;
341 
342 	if (sdhc_clk / 16 > clock) {
343 		for (pre_div = 2; pre_div < 256; pre_div *= 2)
344 			if ((sdhc_clk / pre_div) <= (clock * 16))
345 				break;
346 	} else
347 		pre_div = 2;
348 
349 	for (div = 1; div <= 16; div++)
350 		if ((sdhc_clk / (div * pre_div)) <= clock)
351 			break;
352 
353 	pre_div >>= 1;
354 	div -= 1;
355 
356 	clk = (pre_div << 8) | (div << 4);
357 
358 	esdhc_clrbits32(&regs->sysctl, SYSCTL_CKEN);
359 
360 	esdhc_clrsetbits32(&regs->sysctl, SYSCTL_CLOCK_MASK, clk);
361 
362 	udelay(10000);
363 
364 	clk = SYSCTL_PEREN | SYSCTL_CKEN;
365 
366 	esdhc_setbits32(&regs->sysctl, clk);
367 }
368 
369 static void esdhc_set_ios(struct mmc *mmc)
370 {
371 	struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
372 	struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
373 
374 	/* Set the clock speed */
375 	set_sysctl(mmc, mmc->clock);
376 
377 	/* Set the bus width */
378 	esdhc_clrbits32(&regs->proctl, PROCTL_DTW_4 | PROCTL_DTW_8);
379 
380 	if (mmc->bus_width == 4)
381 		esdhc_setbits32(&regs->proctl, PROCTL_DTW_4);
382 	else if (mmc->bus_width == 8)
383 		esdhc_setbits32(&regs->proctl, PROCTL_DTW_8);
384 
385 }
386 
387 static int esdhc_init(struct mmc *mmc)
388 {
389 	struct fsl_esdhc_cfg *cfg = (struct fsl_esdhc_cfg *)mmc->priv;
390 	struct fsl_esdhc *regs = (struct fsl_esdhc *)cfg->esdhc_base;
391 	int timeout = 1000;
392 	int ret = 0;
393 	u8 card_absent;
394 
395 	/* Reset the entire host controller */
396 	esdhc_write32(&regs->sysctl, SYSCTL_RSTA);
397 
398 	/* Wait until the controller is available */
399 	while ((esdhc_read32(&regs->sysctl) & SYSCTL_RSTA) && --timeout)
400 		udelay(1000);
401 
402 	/* Enable cache snooping */
403 	if (cfg && !cfg->no_snoop)
404 		esdhc_write32(&regs->scr, 0x00000040);
405 
406 	esdhc_write32(&regs->sysctl, SYSCTL_HCKEN | SYSCTL_IPGEN);
407 
408 	/* Set the initial clock speed */
409 	mmc_set_clock(mmc, 400000);
410 
411 	/* Disable the BRR and BWR bits in IRQSTAT */
412 	esdhc_clrbits32(&regs->irqstaten, IRQSTATEN_BRR | IRQSTATEN_BWR);
413 
414 	/* Put the PROCTL reg back to the default */
415 	esdhc_write32(&regs->proctl, PROCTL_INIT);
416 
417 	/* Set timout to the maximum value */
418 	esdhc_clrsetbits32(&regs->sysctl, SYSCTL_TIMEOUT_MASK, 14 << 16);
419 
420 	/* Check if there is a callback for detecting the card */
421 	if (board_mmc_getcd(&card_absent, mmc)) {
422 		timeout = 1000;
423 		while (!(esdhc_read32(&regs->prsstat) & PRSSTAT_CINS) &&
424 				--timeout)
425 			udelay(1000);
426 
427 		if (timeout <= 0)
428 			ret = NO_CARD_ERR;
429 	} else {
430 		if (card_absent)
431 			ret = NO_CARD_ERR;
432 	}
433 
434 	return ret;
435 }
436 
437 static void esdhc_reset(struct fsl_esdhc *regs)
438 {
439 	unsigned long timeout = 100; /* wait max 100 ms */
440 
441 	/* reset the controller */
442 	esdhc_write32(&regs->sysctl, SYSCTL_RSTA);
443 
444 	/* hardware clears the bit when it is done */
445 	while ((esdhc_read32(&regs->sysctl) & SYSCTL_RSTA) && --timeout)
446 		udelay(1000);
447 	if (!timeout)
448 		printf("MMC/SD: Reset never completed.\n");
449 }
450 
451 int fsl_esdhc_initialize(bd_t *bis, struct fsl_esdhc_cfg *cfg)
452 {
453 	struct fsl_esdhc *regs;
454 	struct mmc *mmc;
455 	u32 caps, voltage_caps;
456 
457 	if (!cfg)
458 		return -1;
459 
460 	mmc = malloc(sizeof(struct mmc));
461 
462 	sprintf(mmc->name, "FSL_ESDHC");
463 	regs = (struct fsl_esdhc *)cfg->esdhc_base;
464 
465 	/* First reset the eSDHC controller */
466 	esdhc_reset(regs);
467 
468 	mmc->priv = cfg;
469 	mmc->send_cmd = esdhc_send_cmd;
470 	mmc->set_ios = esdhc_set_ios;
471 	mmc->init = esdhc_init;
472 
473 	voltage_caps = 0;
474 	caps = regs->hostcapblt;
475 
476 #ifdef CONFIG_SYS_FSL_ERRATUM_ESDHC135
477 	caps = caps & ~(ESDHC_HOSTCAPBLT_SRS |
478 			ESDHC_HOSTCAPBLT_VS18 | ESDHC_HOSTCAPBLT_VS30);
479 #endif
480 	if (caps & ESDHC_HOSTCAPBLT_VS18)
481 		voltage_caps |= MMC_VDD_165_195;
482 	if (caps & ESDHC_HOSTCAPBLT_VS30)
483 		voltage_caps |= MMC_VDD_29_30 | MMC_VDD_30_31;
484 	if (caps & ESDHC_HOSTCAPBLT_VS33)
485 		voltage_caps |= MMC_VDD_32_33 | MMC_VDD_33_34;
486 
487 #ifdef CONFIG_SYS_SD_VOLTAGE
488 	mmc->voltages = CONFIG_SYS_SD_VOLTAGE;
489 #else
490 	mmc->voltages = MMC_VDD_32_33 | MMC_VDD_33_34;
491 #endif
492 	if ((mmc->voltages & voltage_caps) == 0) {
493 		printf("voltage not supported by controller\n");
494 		return -1;
495 	}
496 
497 	mmc->host_caps = MMC_MODE_4BIT | MMC_MODE_8BIT;
498 
499 	if (caps & ESDHC_HOSTCAPBLT_HSS)
500 		mmc->host_caps |= MMC_MODE_HS_52MHz | MMC_MODE_HS;
501 
502 	mmc->f_min = 400000;
503 	mmc->f_max = MIN(gd->sdhc_clk, 52000000);
504 
505 	mmc_register(mmc);
506 
507 	return 0;
508 }
509 
510 int fsl_esdhc_mmc_init(bd_t *bis)
511 {
512 	struct fsl_esdhc_cfg *cfg;
513 
514 	cfg = malloc(sizeof(struct fsl_esdhc_cfg));
515 	memset(cfg, 0, sizeof(struct fsl_esdhc_cfg));
516 	cfg->esdhc_base = CONFIG_SYS_FSL_ESDHC_ADDR;
517 	return fsl_esdhc_initialize(bis, cfg);
518 }
519 
520 #ifdef CONFIG_OF_LIBFDT
521 void fdt_fixup_esdhc(void *blob, bd_t *bd)
522 {
523 	const char *compat = "fsl,esdhc";
524 
525 #ifdef CONFIG_FSL_ESDHC_PIN_MUX
526 	if (!hwconfig("esdhc")) {
527 		do_fixup_by_compat(blob, compat, "status", "disabled",
528 				8 + 1, 1);
529 		return;
530 	}
531 #endif
532 
533 	do_fixup_by_compat_u32(blob, compat, "clock-frequency",
534 			       gd->sdhc_clk, 1);
535 
536 	do_fixup_by_compat(blob, compat, "status", "okay",
537 			   4 + 1, 1);
538 }
539 #endif
540