xref: /rk3399_rockchip-uboot/env/nand.c (revision 0649cd0d4908d9b983a0361b8665938ef25701be) 
1 /*
2  * (C) Copyright 2000-2010
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * (C) Copyright 2008
6  * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
7  *
8  * (C) Copyright 2004
9  * Jian Zhang, Texas Instruments, jzhang@ti.com.
10  *
11  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
12  * Andreas Heppel <aheppel@sysgo.de>
13  *
14  * SPDX-License-Identifier:	GPL-2.0+
15  */
16 
17 #include <common.h>
18 #include <command.h>
19 #include <environment.h>
20 #include <linux/stddef.h>
21 #include <malloc.h>
22 #include <memalign.h>
23 #include <nand.h>
24 #include <search.h>
25 #include <errno.h>
26 
27 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
28 #define CMD_SAVEENV
29 #elif defined(CONFIG_ENV_OFFSET_REDUND)
30 #error CONFIG_ENV_OFFSET_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
31 #endif
32 
33 #if defined(CONFIG_ENV_SIZE_REDUND) &&	\
34 	(CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
35 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
36 #endif
37 
38 #ifndef CONFIG_ENV_RANGE
39 #define CONFIG_ENV_RANGE	CONFIG_ENV_SIZE
40 #endif
41 
42 char *env_name_spec = "NAND";
43 
44 #if defined(ENV_IS_EMBEDDED)
45 env_t *env_ptr = &environment;
46 #elif defined(CONFIG_NAND_ENV_DST)
47 env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
48 #else /* ! ENV_IS_EMBEDDED */
49 env_t *env_ptr;
50 #endif /* ENV_IS_EMBEDDED */
51 
52 DECLARE_GLOBAL_DATA_PTR;
53 
54 /*
55  * This is called before nand_init() so we can't read NAND to
56  * validate env data.
57  *
58  * Mark it OK for now. env_relocate() in env_common.c will call our
59  * relocate function which does the real validation.
60  *
61  * When using a NAND boot image (like sequoia_nand), the environment
62  * can be embedded or attached to the U-Boot image in NAND flash.
63  * This way the SPL loads not only the U-Boot image from NAND but
64  * also the environment.
65  */
66 int env_init(void)
67 {
68 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
69 	int crc1_ok = 0, crc2_ok = 0;
70 	env_t *tmp_env1;
71 
72 #ifdef CONFIG_ENV_OFFSET_REDUND
73 	env_t *tmp_env2;
74 
75 	tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
76 	crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
77 #endif
78 	tmp_env1 = env_ptr;
79 	crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
80 
81 	if (!crc1_ok && !crc2_ok) {
82 		gd->env_addr	= 0;
83 		gd->env_valid	= 0;
84 
85 		return 0;
86 	} else if (crc1_ok && !crc2_ok) {
87 		gd->env_valid = 1;
88 	}
89 #ifdef CONFIG_ENV_OFFSET_REDUND
90 	else if (!crc1_ok && crc2_ok) {
91 		gd->env_valid = 2;
92 	} else {
93 		/* both ok - check serial */
94 		if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
95 			gd->env_valid = 2;
96 		else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
97 			gd->env_valid = 1;
98 		else if (tmp_env1->flags > tmp_env2->flags)
99 			gd->env_valid = 1;
100 		else if (tmp_env2->flags > tmp_env1->flags)
101 			gd->env_valid = 2;
102 		else /* flags are equal - almost impossible */
103 			gd->env_valid = 1;
104 	}
105 
106 	if (gd->env_valid == 2)
107 		env_ptr = tmp_env2;
108 	else
109 #endif
110 	if (gd->env_valid == 1)
111 		env_ptr = tmp_env1;
112 
113 	gd->env_addr = (ulong)env_ptr->data;
114 
115 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
116 	gd->env_addr	= (ulong)&default_environment[0];
117 	gd->env_valid	= 1;
118 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
119 
120 	return 0;
121 }
122 
123 #ifdef CMD_SAVEENV
124 /*
125  * The legacy NAND code saved the environment in the first NAND device i.e.,
126  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
127  */
128 static int writeenv(size_t offset, u_char *buf)
129 {
130 	size_t end = offset + CONFIG_ENV_RANGE;
131 	size_t amount_saved = 0;
132 	size_t blocksize, len;
133 	struct mtd_info *mtd;
134 	u_char *char_ptr;
135 
136 	mtd = get_nand_dev_by_index(0);
137 	if (!mtd)
138 		return 1;
139 
140 	blocksize = mtd->erasesize;
141 	len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
142 
143 	while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
144 		if (nand_block_isbad(mtd, offset)) {
145 			offset += blocksize;
146 		} else {
147 			char_ptr = &buf[amount_saved];
148 			if (nand_write(mtd, offset, &len, char_ptr))
149 				return 1;
150 
151 			offset += blocksize;
152 			amount_saved += len;
153 		}
154 	}
155 	if (amount_saved != CONFIG_ENV_SIZE)
156 		return 1;
157 
158 	return 0;
159 }
160 
161 struct env_location {
162 	const char *name;
163 	const nand_erase_options_t erase_opts;
164 };
165 
166 static int erase_and_write_env(const struct env_location *location,
167 		u_char *env_new)
168 {
169 	struct mtd_info *mtd;
170 	int ret = 0;
171 
172 	mtd = get_nand_dev_by_index(0);
173 	if (!mtd)
174 		return 1;
175 
176 	printf("Erasing %s...\n", location->name);
177 	if (nand_erase_opts(mtd, &location->erase_opts))
178 		return 1;
179 
180 	printf("Writing to %s... ", location->name);
181 	ret = writeenv(location->erase_opts.offset, env_new);
182 	puts(ret ? "FAILED!\n" : "OK\n");
183 
184 	return ret;
185 }
186 
187 int saveenv(void)
188 {
189 	int	ret = 0;
190 	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
191 	int	env_idx = 0;
192 	static const struct env_location location[] = {
193 		{
194 			.name = "NAND",
195 			.erase_opts = {
196 				.length = CONFIG_ENV_RANGE,
197 				.offset = CONFIG_ENV_OFFSET,
198 			},
199 		},
200 #ifdef CONFIG_ENV_OFFSET_REDUND
201 		{
202 			.name = "redundant NAND",
203 			.erase_opts = {
204 				.length = CONFIG_ENV_RANGE,
205 				.offset = CONFIG_ENV_OFFSET_REDUND,
206 			},
207 		},
208 #endif
209 	};
210 
211 
212 	if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
213 		return 1;
214 
215 	ret = env_export(env_new);
216 	if (ret)
217 		return ret;
218 
219 #ifdef CONFIG_ENV_OFFSET_REDUND
220 	env_idx = (gd->env_valid == 1);
221 #endif
222 
223 	ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
224 #ifdef CONFIG_ENV_OFFSET_REDUND
225 	if (!ret) {
226 		/* preset other copy for next write */
227 		gd->env_valid = gd->env_valid == 2 ? 1 : 2;
228 		return ret;
229 	}
230 
231 	env_idx = (env_idx + 1) & 1;
232 	ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
233 	if (!ret)
234 		printf("Warning: primary env write failed,"
235 				" redundancy is lost!\n");
236 #endif
237 
238 	return ret;
239 }
240 #endif /* CMD_SAVEENV */
241 
242 #if defined(CONFIG_SPL_BUILD)
243 static int readenv(size_t offset, u_char *buf)
244 {
245 	return nand_spl_load_image(offset, CONFIG_ENV_SIZE, buf);
246 }
247 #else
248 static int readenv(size_t offset, u_char *buf)
249 {
250 	size_t end = offset + CONFIG_ENV_RANGE;
251 	size_t amount_loaded = 0;
252 	size_t blocksize, len;
253 	struct mtd_info *mtd;
254 	u_char *char_ptr;
255 
256 	mtd = get_nand_dev_by_index(0);
257 	if (!mtd)
258 		return 1;
259 
260 	blocksize = mtd->erasesize;
261 	len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
262 
263 	while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
264 		if (nand_block_isbad(mtd, offset)) {
265 			offset += blocksize;
266 		} else {
267 			char_ptr = &buf[amount_loaded];
268 			if (nand_read_skip_bad(mtd, offset,
269 					       &len, NULL,
270 					       mtd->size, char_ptr))
271 				return 1;
272 
273 			offset += blocksize;
274 			amount_loaded += len;
275 		}
276 	}
277 
278 	if (amount_loaded != CONFIG_ENV_SIZE)
279 		return 1;
280 
281 	return 0;
282 }
283 #endif /* #if defined(CONFIG_SPL_BUILD) */
284 
285 #ifdef CONFIG_ENV_OFFSET_OOB
286 int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result)
287 {
288 	struct mtd_oob_ops ops;
289 	uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
290 	int ret;
291 
292 	ops.datbuf	= NULL;
293 	ops.mode	= MTD_OOB_AUTO;
294 	ops.ooboffs	= 0;
295 	ops.ooblen	= ENV_OFFSET_SIZE;
296 	ops.oobbuf	= (void *)oob_buf;
297 
298 	ret = mtd->read_oob(mtd, ENV_OFFSET_SIZE, &ops);
299 	if (ret) {
300 		printf("error reading OOB block 0\n");
301 		return ret;
302 	}
303 
304 	if (oob_buf[0] == ENV_OOB_MARKER) {
305 		*result = oob_buf[1] * mtd->erasesize;
306 	} else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
307 		*result = oob_buf[1];
308 	} else {
309 		printf("No dynamic environment marker in OOB block 0\n");
310 		return -ENOENT;
311 	}
312 
313 	return 0;
314 }
315 #endif
316 
317 #ifdef CONFIG_ENV_OFFSET_REDUND
318 void env_relocate_spec(void)
319 {
320 #if !defined(ENV_IS_EMBEDDED)
321 	int read1_fail = 0, read2_fail = 0;
322 	env_t *tmp_env1, *tmp_env2;
323 
324 	tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
325 	tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
326 	if (tmp_env1 == NULL || tmp_env2 == NULL) {
327 		puts("Can't allocate buffers for environment\n");
328 		set_default_env("!malloc() failed");
329 		goto done;
330 	}
331 
332 	read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
333 	read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
334 
335 	if (read1_fail && read2_fail)
336 		puts("*** Error - No Valid Environment Area found\n");
337 	else if (read1_fail || read2_fail)
338 		puts("*** Warning - some problems detected "
339 		     "reading environment; recovered successfully\n");
340 
341 	if (read1_fail && read2_fail) {
342 		set_default_env("!bad env area");
343 		goto done;
344 	} else if (!read1_fail && read2_fail) {
345 		gd->env_valid = 1;
346 		env_import((char *)tmp_env1, 1);
347 	} else if (read1_fail && !read2_fail) {
348 		gd->env_valid = 2;
349 		env_import((char *)tmp_env2, 1);
350 	} else {
351 		env_import_redund((char *)tmp_env1, (char *)tmp_env2);
352 	}
353 
354 done:
355 	free(tmp_env1);
356 	free(tmp_env2);
357 
358 #endif /* ! ENV_IS_EMBEDDED */
359 }
360 #else /* ! CONFIG_ENV_OFFSET_REDUND */
361 /*
362  * The legacy NAND code saved the environment in the first NAND
363  * device i.e., nand_dev_desc + 0. This is also the behaviour using
364  * the new NAND code.
365  */
366 void env_relocate_spec(void)
367 {
368 #if !defined(ENV_IS_EMBEDDED)
369 	int ret;
370 	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
371 
372 #if defined(CONFIG_ENV_OFFSET_OOB)
373 	struct mtd_info *mtd  = get_nand_dev_by_index(0);
374 	/*
375 	 * If unable to read environment offset from NAND OOB then fall through
376 	 * to the normal environment reading code below
377 	 */
378 	if (mtd && !get_nand_env_oob(mtd, &nand_env_oob_offset)) {
379 		printf("Found Environment offset in OOB..\n");
380 	} else {
381 		set_default_env("!no env offset in OOB");
382 		return;
383 	}
384 #endif
385 
386 	ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
387 	if (ret) {
388 		set_default_env("!readenv() failed");
389 		return;
390 	}
391 
392 	env_import(buf, 1);
393 #endif /* ! ENV_IS_EMBEDDED */
394 }
395 #endif /* CONFIG_ENV_OFFSET_REDUND */
396