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) && \
28 !defined(CONFIG_SPL_BUILD)
30 #elif defined(CONFIG_ENV_OFFSET_REDUND)
31 #error CONFIG_ENV_OFFSET_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
34 #if defined(CONFIG_ENV_SIZE_REDUND) && \
35 (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
36 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
39 #ifndef CONFIG_ENV_RANGE
40 #define CONFIG_ENV_RANGE CONFIG_ENV_SIZE
43 char *env_name_spec = "NAND";
45 #if defined(ENV_IS_EMBEDDED)
46 env_t *env_ptr = &environment;
47 #elif defined(CONFIG_NAND_ENV_DST)
48 env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
49 #else /* ! ENV_IS_EMBEDDED */
51 #endif /* ENV_IS_EMBEDDED */
53 DECLARE_GLOBAL_DATA_PTR;
56 * This is called before nand_init() so we can't read NAND to
59 * Mark it OK for now. env_relocate() in env_common.c will call our
60 * relocate function which does the real validation.
62 * When using a NAND boot image (like sequoia_nand), the environment
63 * can be embedded or attached to the U-Boot image in NAND flash.
64 * This way the SPL loads not only the U-Boot image from NAND but
65 * also the environment.
69 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
70 int crc1_ok = 0, crc2_ok = 0;
73 #ifdef CONFIG_ENV_OFFSET_REDUND
76 tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
77 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
80 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
82 if (!crc1_ok && !crc2_ok) {
87 } else if (crc1_ok && !crc2_ok) {
88 gd->env_valid = ENV_VALID;
90 #ifdef CONFIG_ENV_OFFSET_REDUND
91 else if (!crc1_ok && crc2_ok) {
92 gd->env_valid = ENV_REDUND;
94 /* both ok - check serial */
95 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
96 gd->env_valid = ENV_REDUND;
97 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
98 gd->env_valid = ENV_VALID;
99 else if (tmp_env1->flags > tmp_env2->flags)
100 gd->env_valid = ENV_VALID;
101 else if (tmp_env2->flags > tmp_env1->flags)
102 gd->env_valid = ENV_REDUND;
103 else /* flags are equal - almost impossible */
104 gd->env_valid = ENV_VALID;
107 if (gd->env_valid == ENV_REDUND)
111 if (gd->env_valid == ENV_VALID)
114 gd->env_addr = (ulong)env_ptr->data;
116 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
117 gd->env_addr = (ulong)&default_environment[0];
118 gd->env_valid = ENV_VALID;
119 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
126 * The legacy NAND code saved the environment in the first NAND device i.e.,
127 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
129 static int writeenv(size_t offset, u_char *buf)
131 size_t end = offset + CONFIG_ENV_RANGE;
132 size_t amount_saved = 0;
133 size_t blocksize, len;
134 struct mtd_info *mtd;
137 mtd = get_nand_dev_by_index(0);
141 blocksize = mtd->erasesize;
142 len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
144 while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
145 if (nand_block_isbad(mtd, offset)) {
148 char_ptr = &buf[amount_saved];
149 if (nand_write(mtd, offset, &len, char_ptr))
156 if (amount_saved != CONFIG_ENV_SIZE)
162 struct nand_env_location {
164 const nand_erase_options_t erase_opts;
167 static int erase_and_write_env(const struct nand_env_location *location,
170 struct mtd_info *mtd;
173 mtd = get_nand_dev_by_index(0);
177 printf("Erasing %s...\n", location->name);
178 if (nand_erase_opts(mtd, &location->erase_opts))
181 printf("Writing to %s... ", location->name);
182 ret = writeenv(location->erase_opts.offset, env_new);
183 puts(ret ? "FAILED!\n" : "OK\n");
191 ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
193 static const struct nand_env_location location[] = {
197 .length = CONFIG_ENV_RANGE,
198 .offset = CONFIG_ENV_OFFSET,
201 #ifdef CONFIG_ENV_OFFSET_REDUND
203 .name = "redundant NAND",
205 .length = CONFIG_ENV_RANGE,
206 .offset = CONFIG_ENV_OFFSET_REDUND,
213 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
216 ret = env_export(env_new);
220 #ifdef CONFIG_ENV_OFFSET_REDUND
221 env_idx = (gd->env_valid == ENV_VALID);
224 ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
225 #ifdef CONFIG_ENV_OFFSET_REDUND
227 /* preset other copy for next write */
228 gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID :
233 env_idx = (env_idx + 1) & 1;
234 ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
236 printf("Warning: primary env write failed,"
237 " redundancy is lost!\n");
242 #endif /* CMD_SAVEENV */
244 #if defined(CONFIG_SPL_BUILD)
245 static int readenv(size_t offset, u_char *buf)
247 return nand_spl_load_image(offset, CONFIG_ENV_SIZE, buf);
250 static int readenv(size_t offset, u_char *buf)
252 size_t end = offset + CONFIG_ENV_RANGE;
253 size_t amount_loaded = 0;
254 size_t blocksize, len;
255 struct mtd_info *mtd;
258 mtd = get_nand_dev_by_index(0);
262 blocksize = mtd->erasesize;
263 len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
265 while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
266 if (nand_block_isbad(mtd, offset)) {
269 char_ptr = &buf[amount_loaded];
270 if (nand_read_skip_bad(mtd, offset,
272 mtd->size, char_ptr))
276 amount_loaded += len;
280 if (amount_loaded != CONFIG_ENV_SIZE)
285 #endif /* #if defined(CONFIG_SPL_BUILD) */
287 #ifdef CONFIG_ENV_OFFSET_OOB
288 int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result)
290 struct mtd_oob_ops ops;
291 uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
295 ops.mode = MTD_OOB_AUTO;
297 ops.ooblen = ENV_OFFSET_SIZE;
298 ops.oobbuf = (void *)oob_buf;
300 ret = mtd->read_oob(mtd, ENV_OFFSET_SIZE, &ops);
302 printf("error reading OOB block 0\n");
306 if (oob_buf[0] == ENV_OOB_MARKER) {
307 *result = oob_buf[1] * mtd->erasesize;
308 } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
309 *result = oob_buf[1];
311 printf("No dynamic environment marker in OOB block 0\n");
319 #ifdef CONFIG_ENV_OFFSET_REDUND
320 void env_relocate_spec(void)
322 #if !defined(ENV_IS_EMBEDDED)
323 int read1_fail = 0, read2_fail = 0;
324 env_t *tmp_env1, *tmp_env2;
326 tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
327 tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
328 if (tmp_env1 == NULL || tmp_env2 == NULL) {
329 puts("Can't allocate buffers for environment\n");
330 set_default_env("!malloc() failed");
334 read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
335 read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
337 if (read1_fail && read2_fail)
338 puts("*** Error - No Valid Environment Area found\n");
339 else if (read1_fail || read2_fail)
340 puts("*** Warning - some problems detected "
341 "reading environment; recovered successfully\n");
343 if (read1_fail && read2_fail) {
344 set_default_env("!bad env area");
346 } else if (!read1_fail && read2_fail) {
347 gd->env_valid = ENV_VALID;
348 env_import((char *)tmp_env1, 1);
349 } else if (read1_fail && !read2_fail) {
350 gd->env_valid = ENV_REDUND;
351 env_import((char *)tmp_env2, 1);
353 env_import_redund((char *)tmp_env1, (char *)tmp_env2);
360 #endif /* ! ENV_IS_EMBEDDED */
362 #else /* ! CONFIG_ENV_OFFSET_REDUND */
364 * The legacy NAND code saved the environment in the first NAND
365 * device i.e., nand_dev_desc + 0. This is also the behaviour using
368 void env_relocate_spec(void)
370 #if !defined(ENV_IS_EMBEDDED)
372 ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
374 #if defined(CONFIG_ENV_OFFSET_OOB)
375 struct mtd_info *mtd = get_nand_dev_by_index(0);
377 * If unable to read environment offset from NAND OOB then fall through
378 * to the normal environment reading code below
380 if (mtd && !get_nand_env_oob(mtd, &nand_env_oob_offset)) {
381 printf("Found Environment offset in OOB..\n");
383 set_default_env("!no env offset in OOB");
388 ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
390 set_default_env("!readenv() failed");
395 #endif /* ! ENV_IS_EMBEDDED */
397 #endif /* CONFIG_ENV_OFFSET_REDUND */
399 U_BOOT_ENV_LOCATION(nand) = {
400 .location = ENVL_NAND,
401 .load = env_relocate_spec,
402 #if defined(CMD_SAVEENV)
403 .save = env_save_ptr(saveenv),