2 * (C) Copyright 2000-2010
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
9 * Jian Zhang, Texas Instruments, jzhang@ti.com.
11 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
12 * Andreas Heppel <aheppel@sysgo.de>
14 * SPDX-License-Identifier: GPL-2.0+
19 #include <environment.h>
20 #include <linux/stddef.h>
27 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
29 #elif defined(CONFIG_ENV_OFFSET_REDUND)
30 #error CONFIG_ENV_OFFSET_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
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
38 #ifndef CONFIG_ENV_RANGE
39 #define CONFIG_ENV_RANGE CONFIG_ENV_SIZE
42 char *env_name_spec = "NAND";
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 */
50 #endif /* ENV_IS_EMBEDDED */
52 DECLARE_GLOBAL_DATA_PTR;
55 * This is called before nand_init() so we can't read NAND to
58 * Mark it OK for now. env_relocate() in env_common.c will call our
59 * relocate function which does the real validation.
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.
68 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
69 int crc1_ok = 0, crc2_ok = 0;
72 #ifdef CONFIG_ENV_OFFSET_REDUND
75 tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
76 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
79 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
81 if (!crc1_ok && !crc2_ok) {
86 } else if (crc1_ok && !crc2_ok) {
87 gd->env_valid = ENV_VALID;
89 #ifdef CONFIG_ENV_OFFSET_REDUND
90 else if (!crc1_ok && crc2_ok) {
91 gd->env_valid = ENV_REDUND;
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;
106 if (gd->env_valid == ENV_REDUND)
110 if (gd->env_valid == ENV_VALID)
113 gd->env_addr = (ulong)env_ptr->data;
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 */
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.
128 static int writeenv(size_t offset, u_char *buf)
130 size_t end = offset + CONFIG_ENV_RANGE;
131 size_t amount_saved = 0;
132 size_t blocksize, len;
133 struct mtd_info *mtd;
136 mtd = get_nand_dev_by_index(0);
140 blocksize = mtd->erasesize;
141 len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
143 while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
144 if (nand_block_isbad(mtd, offset)) {
147 char_ptr = &buf[amount_saved];
148 if (nand_write(mtd, offset, &len, char_ptr))
155 if (amount_saved != CONFIG_ENV_SIZE)
161 struct nand_env_location {
163 const nand_erase_options_t erase_opts;
166 static int erase_and_write_env(const struct nand_env_location *location,
169 struct mtd_info *mtd;
172 mtd = get_nand_dev_by_index(0);
176 printf("Erasing %s...\n", location->name);
177 if (nand_erase_opts(mtd, &location->erase_opts))
180 printf("Writing to %s... ", location->name);
181 ret = writeenv(location->erase_opts.offset, env_new);
182 puts(ret ? "FAILED!\n" : "OK\n");
190 ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
192 static const struct nand_env_location location[] = {
196 .length = CONFIG_ENV_RANGE,
197 .offset = CONFIG_ENV_OFFSET,
200 #ifdef CONFIG_ENV_OFFSET_REDUND
202 .name = "redundant NAND",
204 .length = CONFIG_ENV_RANGE,
205 .offset = CONFIG_ENV_OFFSET_REDUND,
212 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
215 ret = env_export(env_new);
219 #ifdef CONFIG_ENV_OFFSET_REDUND
220 env_idx = (gd->env_valid == ENV_VALID);
223 ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
224 #ifdef CONFIG_ENV_OFFSET_REDUND
226 /* preset other copy for next write */
227 gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID :
232 env_idx = (env_idx + 1) & 1;
233 ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
235 printf("Warning: primary env write failed,"
236 " redundancy is lost!\n");
241 #endif /* CMD_SAVEENV */
243 #if defined(CONFIG_SPL_BUILD)
244 static int readenv(size_t offset, u_char *buf)
246 return nand_spl_load_image(offset, CONFIG_ENV_SIZE, buf);
249 static int readenv(size_t offset, u_char *buf)
251 size_t end = offset + CONFIG_ENV_RANGE;
252 size_t amount_loaded = 0;
253 size_t blocksize, len;
254 struct mtd_info *mtd;
257 mtd = get_nand_dev_by_index(0);
261 blocksize = mtd->erasesize;
262 len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
264 while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
265 if (nand_block_isbad(mtd, offset)) {
268 char_ptr = &buf[amount_loaded];
269 if (nand_read_skip_bad(mtd, offset,
271 mtd->size, char_ptr))
275 amount_loaded += len;
279 if (amount_loaded != CONFIG_ENV_SIZE)
284 #endif /* #if defined(CONFIG_SPL_BUILD) */
286 #ifdef CONFIG_ENV_OFFSET_OOB
287 int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result)
289 struct mtd_oob_ops ops;
290 uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
294 ops.mode = MTD_OOB_AUTO;
296 ops.ooblen = ENV_OFFSET_SIZE;
297 ops.oobbuf = (void *)oob_buf;
299 ret = mtd->read_oob(mtd, ENV_OFFSET_SIZE, &ops);
301 printf("error reading OOB block 0\n");
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];
310 printf("No dynamic environment marker in OOB block 0\n");
318 #ifdef CONFIG_ENV_OFFSET_REDUND
319 void env_relocate_spec(void)
321 #if !defined(ENV_IS_EMBEDDED)
322 int read1_fail = 0, read2_fail = 0;
323 env_t *tmp_env1, *tmp_env2;
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");
333 read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
334 read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
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");
342 if (read1_fail && read2_fail) {
343 set_default_env("!bad env area");
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);
352 env_import_redund((char *)tmp_env1, (char *)tmp_env2);
359 #endif /* ! ENV_IS_EMBEDDED */
361 #else /* ! CONFIG_ENV_OFFSET_REDUND */
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
367 void env_relocate_spec(void)
369 #if !defined(ENV_IS_EMBEDDED)
371 ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
373 #if defined(CONFIG_ENV_OFFSET_OOB)
374 struct mtd_info *mtd = get_nand_dev_by_index(0);
376 * If unable to read environment offset from NAND OOB then fall through
377 * to the normal environment reading code below
379 if (mtd && !get_nand_env_oob(mtd, &nand_env_oob_offset)) {
380 printf("Found Environment offset in OOB..\n");
382 set_default_env("!no env offset in OOB");
387 ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
389 set_default_env("!readenv() failed");
394 #endif /* ! ENV_IS_EMBEDDED */
396 #endif /* CONFIG_ENV_OFFSET_REDUND */