xref: /openbmc/u-boot/env/nand.c (revision 203e94f6c9ca03e260175ce240f5856507395585) 
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 = ENV_VALID;
88 	}
89 #ifdef CONFIG_ENV_OFFSET_REDUND
90 	else if (!crc1_ok && crc2_ok) {
91 		gd->env_valid = ENV_REDUND;
92 	} else {
93 		/* both ok - check serial */
94 		if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
95 			gd->env_valid = ENV_REDUND;
96 		else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
97 			gd->env_valid = ENV_VALID;
98 		else if (tmp_env1->flags > tmp_env2->flags)
99 			gd->env_valid = ENV_VALID;
100 		else if (tmp_env2->flags > tmp_env1->flags)
101 			gd->env_valid = ENV_REDUND;
102 		else /* flags are equal - almost impossible */
103 			gd->env_valid = ENV_VALID;
104 	}
105 
106 	if (gd->env_valid == ENV_REDUND)
107 		env_ptr = tmp_env2;
108 	else
109 #endif
110 	if (gd->env_valid == ENV_VALID)
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	= ENV_VALID;
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 == ENV_VALID);
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 == ENV_REDUND ? ENV_VALID :
228 				ENV_REDUND;
229 		return ret;
230 	}
231 
232 	env_idx = (env_idx + 1) & 1;
233 	ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
234 	if (!ret)
235 		printf("Warning: primary env write failed,"
236 				" redundancy is lost!\n");
237 #endif
238 
239 	return ret;
240 }
241 #endif /* CMD_SAVEENV */
242 
243 #if defined(CONFIG_SPL_BUILD)
244 static int readenv(size_t offset, u_char *buf)
245 {
246 	return nand_spl_load_image(offset, CONFIG_ENV_SIZE, buf);
247 }
248 #else
249 static int readenv(size_t offset, u_char *buf)
250 {
251 	size_t end = offset + CONFIG_ENV_RANGE;
252 	size_t amount_loaded = 0;
253 	size_t blocksize, len;
254 	struct mtd_info *mtd;
255 	u_char *char_ptr;
256 
257 	mtd = get_nand_dev_by_index(0);
258 	if (!mtd)
259 		return 1;
260 
261 	blocksize = mtd->erasesize;
262 	len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
263 
264 	while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
265 		if (nand_block_isbad(mtd, offset)) {
266 			offset += blocksize;
267 		} else {
268 			char_ptr = &buf[amount_loaded];
269 			if (nand_read_skip_bad(mtd, offset,
270 					       &len, NULL,
271 					       mtd->size, char_ptr))
272 				return 1;
273 
274 			offset += blocksize;
275 			amount_loaded += len;
276 		}
277 	}
278 
279 	if (amount_loaded != CONFIG_ENV_SIZE)
280 		return 1;
281 
282 	return 0;
283 }
284 #endif /* #if defined(CONFIG_SPL_BUILD) */
285 
286 #ifdef CONFIG_ENV_OFFSET_OOB
287 int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result)
288 {
289 	struct mtd_oob_ops ops;
290 	uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
291 	int ret;
292 
293 	ops.datbuf	= NULL;
294 	ops.mode	= MTD_OOB_AUTO;
295 	ops.ooboffs	= 0;
296 	ops.ooblen	= ENV_OFFSET_SIZE;
297 	ops.oobbuf	= (void *)oob_buf;
298 
299 	ret = mtd->read_oob(mtd, ENV_OFFSET_SIZE, &ops);
300 	if (ret) {
301 		printf("error reading OOB block 0\n");
302 		return ret;
303 	}
304 
305 	if (oob_buf[0] == ENV_OOB_MARKER) {
306 		*result = oob_buf[1] * mtd->erasesize;
307 	} else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
308 		*result = oob_buf[1];
309 	} else {
310 		printf("No dynamic environment marker in OOB block 0\n");
311 		return -ENOENT;
312 	}
313 
314 	return 0;
315 }
316 #endif
317 
318 #ifdef CONFIG_ENV_OFFSET_REDUND
319 void env_relocate_spec(void)
320 {
321 #if !defined(ENV_IS_EMBEDDED)
322 	int read1_fail = 0, read2_fail = 0;
323 	env_t *tmp_env1, *tmp_env2;
324 
325 	tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
326 	tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
327 	if (tmp_env1 == NULL || tmp_env2 == NULL) {
328 		puts("Can't allocate buffers for environment\n");
329 		set_default_env("!malloc() failed");
330 		goto done;
331 	}
332 
333 	read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
334 	read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
335 
336 	if (read1_fail && read2_fail)
337 		puts("*** Error - No Valid Environment Area found\n");
338 	else if (read1_fail || read2_fail)
339 		puts("*** Warning - some problems detected "
340 		     "reading environment; recovered successfully\n");
341 
342 	if (read1_fail && read2_fail) {
343 		set_default_env("!bad env area");
344 		goto done;
345 	} else if (!read1_fail && read2_fail) {
346 		gd->env_valid = ENV_VALID;
347 		env_import((char *)tmp_env1, 1);
348 	} else if (read1_fail && !read2_fail) {
349 		gd->env_valid = ENV_REDUND;
350 		env_import((char *)tmp_env2, 1);
351 	} else {
352 		env_import_redund((char *)tmp_env1, (char *)tmp_env2);
353 	}
354 
355 done:
356 	free(tmp_env1);
357 	free(tmp_env2);
358 
359 #endif /* ! ENV_IS_EMBEDDED */
360 }
361 #else /* ! CONFIG_ENV_OFFSET_REDUND */
362 /*
363  * The legacy NAND code saved the environment in the first NAND
364  * device i.e., nand_dev_desc + 0. This is also the behaviour using
365  * the new NAND code.
366  */
367 void env_relocate_spec(void)
368 {
369 #if !defined(ENV_IS_EMBEDDED)
370 	int ret;
371 	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
372 
373 #if defined(CONFIG_ENV_OFFSET_OOB)
374 	struct mtd_info *mtd  = get_nand_dev_by_index(0);
375 	/*
376 	 * If unable to read environment offset from NAND OOB then fall through
377 	 * to the normal environment reading code below
378 	 */
379 	if (mtd && !get_nand_env_oob(mtd, &nand_env_oob_offset)) {
380 		printf("Found Environment offset in OOB..\n");
381 	} else {
382 		set_default_env("!no env offset in OOB");
383 		return;
384 	}
385 #endif
386 
387 	ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
388 	if (ret) {
389 		set_default_env("!readenv() failed");
390 		return;
391 	}
392 
393 	env_import(buf, 1);
394 #endif /* ! ENV_IS_EMBEDDED */
395 }
396 #endif /* CONFIG_ENV_OFFSET_REDUND */
397