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
;
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 env_location
{
163 const nand_erase_options_t erase_opts
;
166 static int erase_and_write_env(const struct 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 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
== 1);
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
== 2 ? 1 : 2;
231 env_idx
= (env_idx
+ 1) & 1;
232 ret
= erase_and_write_env(&location
[env_idx
], (u_char
*)env_new
);
234 printf("Warning: primary env write failed,"
235 " redundancy is lost!\n");
240 #endif /* CMD_SAVEENV */
242 #if defined(CONFIG_SPL_BUILD)
243 static int readenv(size_t offset
, u_char
*buf
)
245 return nand_spl_load_image(offset
, CONFIG_ENV_SIZE
, buf
);
248 static int readenv(size_t offset
, u_char
*buf
)
250 size_t end
= offset
+ CONFIG_ENV_RANGE
;
251 size_t amount_loaded
= 0;
252 size_t blocksize
, len
;
253 struct mtd_info
*mtd
;
256 mtd
= get_nand_dev_by_index(0);
260 blocksize
= mtd
->erasesize
;
261 len
= min(blocksize
, (size_t)CONFIG_ENV_SIZE
);
263 while (amount_loaded
< CONFIG_ENV_SIZE
&& offset
< end
) {
264 if (nand_block_isbad(mtd
, offset
)) {
267 char_ptr
= &buf
[amount_loaded
];
268 if (nand_read_skip_bad(mtd
, offset
,
270 mtd
->size
, char_ptr
))
274 amount_loaded
+= len
;
278 if (amount_loaded
!= CONFIG_ENV_SIZE
)
283 #endif /* #if defined(CONFIG_SPL_BUILD) */
285 #ifdef CONFIG_ENV_OFFSET_OOB
286 int get_nand_env_oob(struct mtd_info
*mtd
, unsigned long *result
)
288 struct mtd_oob_ops ops
;
289 uint32_t oob_buf
[ENV_OFFSET_SIZE
/ sizeof(uint32_t)];
293 ops
.mode
= MTD_OOB_AUTO
;
295 ops
.ooblen
= ENV_OFFSET_SIZE
;
296 ops
.oobbuf
= (void *)oob_buf
;
298 ret
= mtd
->read_oob(mtd
, ENV_OFFSET_SIZE
, &ops
);
300 printf("error reading OOB block 0\n");
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];
309 printf("No dynamic environment marker in OOB block 0\n");
317 #ifdef CONFIG_ENV_OFFSET_REDUND
318 void env_relocate_spec(void)
320 #if !defined(ENV_IS_EMBEDDED)
321 int read1_fail
= 0, read2_fail
= 0;
322 env_t
*tmp_env1
, *tmp_env2
;
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");
332 read1_fail
= readenv(CONFIG_ENV_OFFSET
, (u_char
*) tmp_env1
);
333 read2_fail
= readenv(CONFIG_ENV_OFFSET_REDUND
, (u_char
*) tmp_env2
);
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");
341 if (read1_fail
&& read2_fail
) {
342 set_default_env("!bad env area");
344 } else if (!read1_fail
&& read2_fail
) {
346 env_import((char *)tmp_env1
, 1);
347 } else if (read1_fail
&& !read2_fail
) {
349 env_import((char *)tmp_env2
, 1);
351 env_import_redund((char *)tmp_env1
, (char *)tmp_env2
);
358 #endif /* ! ENV_IS_EMBEDDED */
360 #else /* ! CONFIG_ENV_OFFSET_REDUND */
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
366 void env_relocate_spec(void)
368 #if !defined(ENV_IS_EMBEDDED)
370 ALLOC_CACHE_ALIGN_BUFFER(char, buf
, CONFIG_ENV_SIZE
);
372 #if defined(CONFIG_ENV_OFFSET_OOB)
373 struct mtd_info
*mtd
= get_nand_dev_by_index(0);
375 * If unable to read environment offset from NAND OOB then fall through
376 * to the normal environment reading code below
378 if (mtd
&& !get_nand_env_oob(mtd
, &nand_env_oob_offset
)) {
379 printf("Found Environment offset in OOB..\n");
381 set_default_env("!no env offset in OOB");
386 ret
= readenv(CONFIG_ENV_OFFSET
, (u_char
*)buf
);
388 set_default_env("!readenv() failed");
393 #endif /* ! ENV_IS_EMBEDDED */
395 #endif /* CONFIG_ENV_OFFSET_REDUND */