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
) {
89 #ifdef CONFIG_ENV_OFFSET_REDUND
90 else if (!crc1_ok
&& crc2_ok
) {
93 /* both ok - check serial */
94 if (tmp_env1
->flags
== 255 && tmp_env2
->flags
== 0)
96 else if (tmp_env2
->flags
== 255 && tmp_env1
->flags
== 0)
98 else if (tmp_env1
->flags
> tmp_env2
->flags
)
100 else if (tmp_env2
->flags
> tmp_env1
->flags
)
102 else /* flags are equal - almost impossible */
106 if (gd
->env_valid
== 2)
110 if (gd
->env_valid
== 1)
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];
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
;
135 blocksize
= nand_info
[0]->erasesize
;
136 len
= min(blocksize
, (size_t)CONFIG_ENV_SIZE
);
138 while (amount_saved
< CONFIG_ENV_SIZE
&& offset
< end
) {
139 if (nand_block_isbad(nand_info
[0], offset
)) {
142 char_ptr
= &buf
[amount_saved
];
143 if (nand_write(nand_info
[0], offset
, &len
, char_ptr
))
150 if (amount_saved
!= CONFIG_ENV_SIZE
)
156 struct env_location
{
158 const nand_erase_options_t erase_opts
;
161 static int erase_and_write_env(const struct env_location
*location
,
169 printf("Erasing %s...\n", location
->name
);
170 if (nand_erase_opts(nand_info
[0], &location
->erase_opts
))
173 printf("Writing to %s... ", location
->name
);
174 ret
= writeenv(location
->erase_opts
.offset
, env_new
);
175 puts(ret
? "FAILED!\n" : "OK\n");
180 #ifdef CONFIG_ENV_OFFSET_REDUND
181 static unsigned char env_flags
;
187 ALLOC_CACHE_ALIGN_BUFFER(env_t
, env_new
, 1);
189 static const struct env_location location
[] = {
193 .length
= CONFIG_ENV_RANGE
,
194 .offset
= CONFIG_ENV_OFFSET
,
197 #ifdef CONFIG_ENV_OFFSET_REDUND
199 .name
= "redundant NAND",
201 .length
= CONFIG_ENV_RANGE
,
202 .offset
= CONFIG_ENV_OFFSET_REDUND
,
209 if (CONFIG_ENV_RANGE
< CONFIG_ENV_SIZE
)
212 ret
= env_export(env_new
);
216 #ifdef CONFIG_ENV_OFFSET_REDUND
217 env_new
->flags
= ++env_flags
; /* increase the serial */
218 env_idx
= (gd
->env_valid
== 1);
221 ret
= erase_and_write_env(&location
[env_idx
], (u_char
*)env_new
);
222 #ifdef CONFIG_ENV_OFFSET_REDUND
224 /* preset other copy for next write */
225 gd
->env_valid
= gd
->env_valid
== 2 ? 1 : 2;
229 env_idx
= (env_idx
+ 1) & 1;
230 ret
= erase_and_write_env(&location
[env_idx
], (u_char
*)env_new
);
232 printf("Warning: primary env write failed,"
233 " redundancy is lost!\n");
238 #endif /* CMD_SAVEENV */
240 #if defined(CONFIG_SPL_BUILD)
241 static int readenv(size_t offset
, u_char
*buf
)
243 return nand_spl_load_image(offset
, CONFIG_ENV_SIZE
, buf
);
246 static int readenv(size_t offset
, u_char
*buf
)
248 size_t end
= offset
+ CONFIG_ENV_RANGE
;
249 size_t amount_loaded
= 0;
250 size_t blocksize
, len
;
256 blocksize
= nand_info
[0]->erasesize
;
257 len
= min(blocksize
, (size_t)CONFIG_ENV_SIZE
);
259 while (amount_loaded
< CONFIG_ENV_SIZE
&& offset
< end
) {
260 if (nand_block_isbad(nand_info
[0], offset
)) {
263 char_ptr
= &buf
[amount_loaded
];
264 if (nand_read_skip_bad(nand_info
[0], offset
,
266 nand_info
[0]->size
, char_ptr
))
270 amount_loaded
+= len
;
274 if (amount_loaded
!= CONFIG_ENV_SIZE
)
279 #endif /* #if defined(CONFIG_SPL_BUILD) */
281 #ifdef CONFIG_ENV_OFFSET_OOB
282 int get_nand_env_oob(struct mtd_info
*mtd
, unsigned long *result
)
284 struct mtd_oob_ops ops
;
285 uint32_t oob_buf
[ENV_OFFSET_SIZE
/ sizeof(uint32_t)];
289 ops
.mode
= MTD_OOB_AUTO
;
291 ops
.ooblen
= ENV_OFFSET_SIZE
;
292 ops
.oobbuf
= (void *)oob_buf
;
294 ret
= mtd
->read_oob(mtd
, ENV_OFFSET_SIZE
, &ops
);
296 printf("error reading OOB block 0\n");
300 if (oob_buf
[0] == ENV_OOB_MARKER
) {
301 *result
= oob_buf
[1] * mtd
->erasesize
;
302 } else if (oob_buf
[0] == ENV_OOB_MARKER_OLD
) {
303 *result
= oob_buf
[1];
305 printf("No dynamic environment marker in OOB block 0\n");
313 #ifdef CONFIG_ENV_OFFSET_REDUND
314 void env_relocate_spec(void)
316 #if !defined(ENV_IS_EMBEDDED)
317 int read1_fail
= 0, read2_fail
= 0;
318 int crc1_ok
= 0, crc2_ok
= 0;
319 env_t
*ep
, *tmp_env1
, *tmp_env2
;
321 tmp_env1
= (env_t
*)malloc(CONFIG_ENV_SIZE
);
322 tmp_env2
= (env_t
*)malloc(CONFIG_ENV_SIZE
);
323 if (tmp_env1
== NULL
|| tmp_env2
== NULL
) {
324 puts("Can't allocate buffers for environment\n");
325 set_default_env("!malloc() failed");
329 read1_fail
= readenv(CONFIG_ENV_OFFSET
, (u_char
*) tmp_env1
);
330 read2_fail
= readenv(CONFIG_ENV_OFFSET_REDUND
, (u_char
*) tmp_env2
);
332 if (read1_fail
&& read2_fail
)
333 puts("*** Error - No Valid Environment Area found\n");
334 else if (read1_fail
|| read2_fail
)
335 puts("*** Warning - some problems detected "
336 "reading environment; recovered successfully\n");
338 crc1_ok
= !read1_fail
&&
339 (crc32(0, tmp_env1
->data
, ENV_SIZE
) == tmp_env1
->crc
);
340 crc2_ok
= !read2_fail
&&
341 (crc32(0, tmp_env2
->data
, ENV_SIZE
) == tmp_env2
->crc
);
343 if (!crc1_ok
&& !crc2_ok
) {
344 set_default_env("!bad CRC");
346 } else if (crc1_ok
&& !crc2_ok
) {
348 } else if (!crc1_ok
&& crc2_ok
) {
351 /* both ok - check serial */
352 if (tmp_env1
->flags
== 255 && tmp_env2
->flags
== 0)
354 else if (tmp_env2
->flags
== 255 && tmp_env1
->flags
== 0)
356 else if (tmp_env1
->flags
> tmp_env2
->flags
)
358 else if (tmp_env2
->flags
> tmp_env1
->flags
)
360 else /* flags are equal - almost impossible */
366 if (gd
->env_valid
== 1)
371 env_flags
= ep
->flags
;
372 env_import((char *)ep
, 0);
378 #endif /* ! ENV_IS_EMBEDDED */
380 #else /* ! CONFIG_ENV_OFFSET_REDUND */
382 * The legacy NAND code saved the environment in the first NAND
383 * device i.e., nand_dev_desc + 0. This is also the behaviour using
386 void env_relocate_spec(void)
388 #if !defined(ENV_IS_EMBEDDED)
390 ALLOC_CACHE_ALIGN_BUFFER(char, buf
, CONFIG_ENV_SIZE
);
392 #if defined(CONFIG_ENV_OFFSET_OOB)
394 * If unable to read environment offset from NAND OOB then fall through
395 * to the normal environment reading code below
397 if (nand_info
[0] && !get_nand_env_oob(nand_info
[0],
398 &nand_env_oob_offset
)) {
399 printf("Found Environment offset in OOB..\n");
401 set_default_env("!no env offset in OOB");
406 ret
= readenv(CONFIG_ENV_OFFSET
, (u_char
*)buf
);
408 set_default_env("!readenv() failed");
413 #endif /* ! ENV_IS_EMBEDDED */
415 #endif /* CONFIG_ENV_OFFSET_REDUND */