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 #if defined(ENV_IS_EMBEDDED)
44 env_t
*env_ptr
= &environment
;
45 #elif defined(CONFIG_NAND_ENV_DST)
46 env_t
*env_ptr
= (env_t
*)CONFIG_NAND_ENV_DST
;
47 #else /* ! ENV_IS_EMBEDDED */
49 #endif /* ENV_IS_EMBEDDED */
51 DECLARE_GLOBAL_DATA_PTR
;
54 * This is called before nand_init() so we can't read NAND to
57 * Mark it OK for now. env_relocate() in env_common.c will call our
58 * relocate function which does the real validation.
60 * When using a NAND boot image (like sequoia_nand), the environment
61 * can be embedded or attached to the U-Boot image in NAND flash.
62 * This way the SPL loads not only the U-Boot image from NAND but
63 * also the environment.
65 static int env_nand_init(void)
67 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
68 int crc1_ok
= 0, crc2_ok
= 0;
71 #ifdef CONFIG_ENV_OFFSET_REDUND
74 tmp_env2
= (env_t
*)((ulong
)env_ptr
+ CONFIG_ENV_SIZE
);
75 crc2_ok
= crc32(0, tmp_env2
->data
, ENV_SIZE
) == tmp_env2
->crc
;
78 crc1_ok
= crc32(0, tmp_env1
->data
, ENV_SIZE
) == tmp_env1
->crc
;
80 if (!crc1_ok
&& !crc2_ok
) {
82 gd
->env_valid
= ENV_INVALID
;
85 } else if (crc1_ok
&& !crc2_ok
) {
86 gd
->env_valid
= ENV_VALID
;
88 #ifdef CONFIG_ENV_OFFSET_REDUND
89 else if (!crc1_ok
&& crc2_ok
) {
90 gd
->env_valid
= ENV_REDUND
;
92 /* both ok - check serial */
93 if (tmp_env1
->flags
== 255 && tmp_env2
->flags
== 0)
94 gd
->env_valid
= ENV_REDUND
;
95 else if (tmp_env2
->flags
== 255 && tmp_env1
->flags
== 0)
96 gd
->env_valid
= ENV_VALID
;
97 else if (tmp_env1
->flags
> tmp_env2
->flags
)
98 gd
->env_valid
= ENV_VALID
;
99 else if (tmp_env2
->flags
> tmp_env1
->flags
)
100 gd
->env_valid
= ENV_REDUND
;
101 else /* flags are equal - almost impossible */
102 gd
->env_valid
= ENV_VALID
;
105 if (gd
->env_valid
== ENV_REDUND
)
109 if (gd
->env_valid
== ENV_VALID
)
112 gd
->env_addr
= (ulong
)env_ptr
->data
;
114 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
115 gd
->env_addr
= (ulong
)&default_environment
[0];
116 gd
->env_valid
= ENV_VALID
;
117 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
124 * The legacy NAND code saved the environment in the first NAND device i.e.,
125 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
127 static int writeenv(size_t offset
, u_char
*buf
)
129 size_t end
= offset
+ CONFIG_ENV_RANGE
;
130 size_t amount_saved
= 0;
131 size_t blocksize
, len
;
132 struct mtd_info
*mtd
;
135 mtd
= get_nand_dev_by_index(0);
139 blocksize
= mtd
->erasesize
;
140 len
= min(blocksize
, (size_t)CONFIG_ENV_SIZE
);
142 while (amount_saved
< CONFIG_ENV_SIZE
&& offset
< end
) {
143 if (nand_block_isbad(mtd
, offset
)) {
146 char_ptr
= &buf
[amount_saved
];
147 if (nand_write(mtd
, offset
, &len
, char_ptr
))
154 if (amount_saved
!= CONFIG_ENV_SIZE
)
160 struct nand_env_location
{
162 const nand_erase_options_t erase_opts
;
165 static int erase_and_write_env(const struct nand_env_location
*location
,
168 struct mtd_info
*mtd
;
171 mtd
= get_nand_dev_by_index(0);
175 printf("Erasing %s...\n", location
->name
);
176 if (nand_erase_opts(mtd
, &location
->erase_opts
))
179 printf("Writing to %s... ", location
->name
);
180 ret
= writeenv(location
->erase_opts
.offset
, env_new
);
181 puts(ret
? "FAILED!\n" : "OK\n");
186 static int env_nand_save(void)
189 ALLOC_CACHE_ALIGN_BUFFER(env_t
, env_new
, 1);
191 static const struct nand_env_location location
[] = {
195 .length
= CONFIG_ENV_RANGE
,
196 .offset
= CONFIG_ENV_OFFSET
,
199 #ifdef CONFIG_ENV_OFFSET_REDUND
201 .name
= "redundant NAND",
203 .length
= CONFIG_ENV_RANGE
,
204 .offset
= CONFIG_ENV_OFFSET_REDUND
,
211 if (CONFIG_ENV_RANGE
< CONFIG_ENV_SIZE
)
214 ret
= env_export(env_new
);
218 #ifdef CONFIG_ENV_OFFSET_REDUND
219 env_idx
= (gd
->env_valid
== ENV_VALID
);
222 ret
= erase_and_write_env(&location
[env_idx
], (u_char
*)env_new
);
223 #ifdef CONFIG_ENV_OFFSET_REDUND
225 /* preset other copy for next write */
226 gd
->env_valid
= gd
->env_valid
== ENV_REDUND
? ENV_VALID
:
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
= ovoid ob_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 static int env_nand_load(void)
320 #if defined(ENV_IS_EMBEDDED)
323 int read1_fail
, read2_fail
;
324 env_t
*tmp_env1
, *tmp_env2
;
327 tmp_env1
= (env_t
*)malloc(CONFIG_ENV_SIZE
);
328 tmp_env2
= (env_t
*)malloc(CONFIG_ENV_SIZE
);
329 if (tmp_env1
== NULL
|| tmp_env2
== NULL
) {
330 puts("Can't allocate buffers for environment\n");
331 set_default_env("!malloc() failed");
336 read1_fail
= readenv(CONFIG_ENV_OFFSET
, (u_char
*) tmp_env1
);
337 read2_fail
= readenv(CONFIG_ENV_OFFSET_REDUND
, (u_char
*) tmp_env2
);
339 ret
= env_import_redund((char *)tmp_env1
, read1_fail
, (char *)tmp_env2
,
347 #endif /* ! ENV_IS_EMBEDDED */
349 #else /* ! CONFIG_ENV_OFFSET_REDUND */
351 * The legacy NAND code saved the environment in the first NAND
352 * device i.e., nand_dev_desc + 0. This is also the behaviour using
355 static int env_nand_load(void)
357 #if !defined(ENV_IS_EMBEDDED)
359 ALLOC_CACHE_ALIGN_BUFFER(char, buf
, CONFIG_ENV_SIZE
);
361 #if defined(CONFIG_ENV_OFFSET_OOB)
362 struct mtd_info
*mtd
= get_nand_dev_by_index(0);
364 * If unable to read environment offset from NAND OOB then fall through
365 * to the normal environment reading code below
367 if (mtd
&& !get_nand_env_oob(mtd
, &nand_env_oob_offset
)) {
368 printf("Found Environment offset in OOB..\n");
370 set_default_env("!no env offset in OOB");
375 ret
= readenv(CONFIG_ENV_OFFSET
, (u_char
*)buf
);
377 set_default_env("!readenv() failed");
381 return env_import(buf
, 1);
382 #endif /* ! ENV_IS_EMBEDDED */
386 #endif /* CONFIG_ENV_OFFSET_REDUND */
388 U_BOOT_ENV_LOCATION(nand
) = {
389 .location
= ENVL_NAND
,
391 .load
= env_nand_load
,
392 #if defined(CMD_SAVEENV)
393 .save
= env_save_ptr(env_nand_save
),
395 .init
= env_nand_init
,