1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * NAND boot for Freescale Enhanced Local Bus Controller, Flash Control Machine
4  *
5  * (C) Copyright 2006-2008
6  * Stefan Roese, DENX Software Engineering, sr@denx.de.
7  *
8  * Copyright (c) 2008 Freescale Semiconductor, Inc.
9  * Author: Scott Wood <scottwood@freescale.com>
10  */
11 
12 #include <common.h>
13 #include <asm/io.h>
14 #include <asm/fsl_lbc.h>
15 #include <nand.h>
16 
17 #define WINDOW_SIZE 8192
18 
19 static void nand_wait(void)
20 {
21 	fsl_lbc_t *regs = LBC_BASE_ADDR;
22 
23 	for (;;) {
24 		uint32_t status = in_be32(&regs->ltesr);
25 
26 		if (status == 1)
27 			return;
28 
29 		if (status & 1) {
30 			puts("read failed (ltesr)\n");
31 			for (;;);
32 		}
33 	}
34 }
35 
36 #ifdef CONFIG_TPL_BUILD
37 int nand_spl_load_image(uint32_t offs, unsigned int uboot_size, void *vdst)
38 #else
39 static int nand_load_image(uint32_t offs, unsigned int uboot_size, void *vdst)
40 #endif
41 {
42 	fsl_lbc_t *regs = LBC_BASE_ADDR;
43 	uchar *buf = (uchar *)CONFIG_SYS_NAND_BASE;
44 	const int large = CONFIG_SYS_NAND_OR_PRELIM & OR_FCM_PGS;
45 	const int block_shift = large ? 17 : 14;
46 	const int block_size = 1 << block_shift;
47 	const int page_size = large ? 2048 : 512;
48 	const int bad_marker = large ? page_size + 0 : page_size + 5;
49 	int fmr = (15 << FMR_CWTO_SHIFT) | (2 << FMR_AL_SHIFT) | 2;
50 	int pos = 0;
51 	char *dst = vdst;
52 
53 	if (offs & (block_size - 1)) {
54 		puts("bad offset\n");
55 		for (;;);
56 	}
57 
58 	if (large) {
59 		fmr |= FMR_ECCM;
60 		out_be32(&regs->fcr, (NAND_CMD_READ0 << FCR_CMD0_SHIFT) |
61 				     (NAND_CMD_READSTART << FCR_CMD1_SHIFT));
62 		out_be32(&regs->fir,
63 			 (FIR_OP_CW0 << FIR_OP0_SHIFT) |
64 			 (FIR_OP_CA  << FIR_OP1_SHIFT) |
65 			 (FIR_OP_PA  << FIR_OP2_SHIFT) |
66 			 (FIR_OP_CW1 << FIR_OP3_SHIFT) |
67 			 (FIR_OP_RBW << FIR_OP4_SHIFT));
68 	} else {
69 		out_be32(&regs->fcr, NAND_CMD_READ0 << FCR_CMD0_SHIFT);
70 		out_be32(&regs->fir,
71 			 (FIR_OP_CW0 << FIR_OP0_SHIFT) |
72 			 (FIR_OP_CA  << FIR_OP1_SHIFT) |
73 			 (FIR_OP_PA  << FIR_OP2_SHIFT) |
74 			 (FIR_OP_RBW << FIR_OP3_SHIFT));
75 	}
76 
77 	out_be32(&regs->fbcr, 0);
78 	clrsetbits_be32(&regs->bank[0].br, BR_DECC, BR_DECC_CHK_GEN);
79 
80 	while (pos < uboot_size) {
81 		int i = 0;
82 		out_be32(&regs->fbar, offs >> block_shift);
83 
84 		do {
85 			int j;
86 			unsigned int page_offs = (offs & (block_size - 1)) << 1;
87 
88 			out_be32(&regs->ltesr, ~0);
89 			out_be32(&regs->lteatr, 0);
90 			out_be32(&regs->fpar, page_offs);
91 			out_be32(&regs->fmr, fmr);
92 			out_be32(&regs->lsor, 0);
93 			nand_wait();
94 
95 			page_offs %= WINDOW_SIZE;
96 
97 			/*
98 			 * If either of the first two pages are marked bad,
99 			 * continue to the next block.
100 			 */
101 			if (i++ < 2 && buf[page_offs + bad_marker] != 0xff) {
102 				puts("skipping\n");
103 				offs = (offs + block_size) & ~(block_size - 1);
104 				pos &= ~(block_size - 1);
105 				break;
106 			}
107 
108 			for (j = 0; j < page_size; j++)
109 				dst[pos + j] = buf[page_offs + j];
110 
111 			pos += page_size;
112 			offs += page_size;
113 		} while ((offs & (block_size - 1)) && (pos < uboot_size));
114 	}
115 
116 	return 0;
117 }
118 
119 /*
120  * Defines a static function nand_load_image() here, because non-static makes
121  * the code too large for certain SPLs(minimal SPL, maximum size <= 4Kbytes)
122  */
123 #ifndef CONFIG_TPL_BUILD
124 #define nand_spl_load_image(offs, uboot_size, vdst) \
125 	nand_load_image(offs, uboot_size, vdst)
126 #endif
127 
128 /*
129  * The main entry for NAND booting. It's necessary that SDRAM is already
130  * configured and available since this code loads the main U-Boot image
131  * from NAND into SDRAM and starts it from there.
132  */
133 void nand_boot(void)
134 {
135 	__attribute__((noreturn)) void (*uboot)(void);
136 	/*
137 	 * Load U-Boot image from NAND into RAM
138 	 */
139 	nand_spl_load_image(CONFIG_SYS_NAND_U_BOOT_OFFS,
140 			    CONFIG_SYS_NAND_U_BOOT_SIZE,
141 			    (void *)CONFIG_SYS_NAND_U_BOOT_DST);
142 
143 #ifdef CONFIG_NAND_ENV_DST
144 	nand_spl_load_image(CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE,
145 			    (void *)CONFIG_NAND_ENV_DST);
146 
147 #ifdef CONFIG_ENV_OFFSET_REDUND
148 	nand_spl_load_image(CONFIG_ENV_OFFSET_REDUND, CONFIG_ENV_SIZE,
149 			    (void *)CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE);
150 #endif
151 #endif
152 
153 #ifdef CONFIG_SPL_FLUSH_IMAGE
154 	/*
155 	 * Clean d-cache and invalidate i-cache, to
156 	 * make sure that no stale data is executed.
157 	 */
158 	flush_cache(CONFIG_SYS_NAND_U_BOOT_DST, CONFIG_SYS_NAND_U_BOOT_SIZE);
159 #endif
160 
161 	puts("transfering control\n");
162 	/*
163 	 * Jump to U-Boot image
164 	 */
165 	uboot = (void *)CONFIG_SYS_NAND_U_BOOT_START;
166 	(*uboot)();
167 }
168