1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2010
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
10 * Jian Zhang, Texas Instruments, jzhang@ti.com.
12 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
13 * Andreas Heppel <aheppel@sysgo.de>
18 #include <environment.h>
19 #include <linux/stddef.h>
26 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND) && \
27 !defined(CONFIG_SPL_BUILD)
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 #if defined(ENV_IS_EMBEDDED)
43 static env_t
*env_ptr
= &environment
;
44 #elif defined(CONFIG_NAND_ENV_DST)
45 static env_t
*env_ptr
= (env_t
*)CONFIG_NAND_ENV_DST
;
46 #endif /* ENV_IS_EMBEDDED */
48 DECLARE_GLOBAL_DATA_PTR
;
51 * This is called before nand_init() so we can't read NAND to
54 * Mark it OK for now. env_relocate() in env_common.c will call our
55 * relocate function which does the real validation.
57 * When using a NAND boot image (like sequoia_nand), the environment
58 * can be embedded or attached to the U-Boot image in NAND flash.
59 * This way the SPL loads not only the U-Boot image from NAND but
60 * also the environment.
62 static int env_nand_init(void)
64 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
65 int crc1_ok
= 0, crc2_ok
= 0;
68 #ifdef CONFIG_ENV_OFFSET_REDUND
71 tmp_env2
= (env_t
*)((ulong
)env_ptr
+ CONFIG_ENV_SIZE
);
72 crc2_ok
= crc32(0, tmp_env2
->data
, ENV_SIZE
) == tmp_env2
->crc
;
75 crc1_ok
= crc32(0, tmp_env1
->data
, ENV_SIZE
) == tmp_env1
->crc
;
77 if (!crc1_ok
&& !crc2_ok
) {
79 gd
->env_valid
= ENV_INVALID
;
82 } else if (crc1_ok
&& !crc2_ok
) {
83 gd
->env_valid
= ENV_VALID
;
85 #ifdef CONFIG_ENV_OFFSET_REDUND
86 else if (!crc1_ok
&& crc2_ok
) {
87 gd
->env_valid
= ENV_REDUND
;
89 /* both ok - check serial */
90 if (tmp_env1
->flags
== 255 && tmp_env2
->flags
== 0)
91 gd
->env_valid
= ENV_REDUND
;
92 else if (tmp_env2
->flags
== 255 && tmp_env1
->flags
== 0)
93 gd
->env_valid
= ENV_VALID
;
94 else if (tmp_env1
->flags
> tmp_env2
->flags
)
95 gd
->env_valid
= ENV_VALID
;
96 else if (tmp_env2
->flags
> tmp_env1
->flags
)
97 gd
->env_valid
= ENV_REDUND
;
98 else /* flags are equal - almost impossible */
99 gd
->env_valid
= ENV_VALID
;
102 if (gd
->env_valid
== ENV_REDUND
)
106 if (gd
->env_valid
== ENV_VALID
)
109 gd
->env_addr
= (ulong
)env_ptr
->data
;
111 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
112 gd
->env_addr
= (ulong
)&default_environment
[0];
113 gd
->env_valid
= ENV_VALID
;
114 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
121 * The legacy NAND code saved the environment in the first NAND device i.e.,
122 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
124 static int writeenv(size_t offset
, u_char
*buf
)
126 size_t end
= offset
+ CONFIG_ENV_RANGE
;
127 size_t amount_saved
= 0;
128 size_t blocksize
, len
;
129 struct mtd_info
*mtd
;
132 mtd
= get_nand_dev_by_index(0);
136 blocksize
= mtd
->erasesize
;
137 len
= min(blocksize
, (size_t)CONFIG_ENV_SIZE
);
139 while (amount_saved
< CONFIG_ENV_SIZE
&& offset
< end
) {
140 if (nand_block_isbad(mtd
, offset
)) {
143 char_ptr
= &buf
[amount_saved
];
144 if (nand_write(mtd
, offset
, &len
, char_ptr
))
151 if (amount_saved
!= CONFIG_ENV_SIZE
)
157 struct nand_env_location
{
159 const nand_erase_options_t erase_opts
;
162 static int erase_and_write_env(const struct nand_env_location
*location
,
165 struct mtd_info
*mtd
;
168 mtd
= get_nand_dev_by_index(0);
172 printf("Erasing %s...\n", location
->name
);
173 if (nand_erase_opts(mtd
, &location
->erase_opts
))
176 printf("Writing to %s... ", location
->name
);
177 ret
= writeenv(location
->erase_opts
.offset
, env_new
);
178 puts(ret
? "FAILED!\n" : "OK\n");
183 static int env_nand_save(void)
186 ALLOC_CACHE_ALIGN_BUFFER(env_t
, env_new
, 1);
188 static const struct nand_env_location location
[] = {
192 .length
= CONFIG_ENV_RANGE
,
193 .offset
= CONFIG_ENV_OFFSET
,
196 #ifdef CONFIG_ENV_OFFSET_REDUND
198 .name
= "redundant NAND",
200 .length
= CONFIG_ENV_RANGE
,
201 .offset
= CONFIG_ENV_OFFSET_REDUND
,
208 if (CONFIG_ENV_RANGE
< CONFIG_ENV_SIZE
)
211 ret
= env_export(env_new
);
215 #ifdef CONFIG_ENV_OFFSET_REDUND
216 env_idx
= (gd
->env_valid
== ENV_VALID
);
219 ret
= erase_and_write_env(&location
[env_idx
], (u_char
*)env_new
);
220 #ifdef CONFIG_ENV_OFFSET_REDUND
222 /* preset other copy for next write */
223 gd
->env_valid
= gd
->env_valid
== ENV_REDUND
? ENV_VALID
:
228 env_idx
= (env_idx
+ 1) & 1;
229 ret
= erase_and_write_env(&location
[env_idx
], (u_char
*)env_new
);
231 printf("Warning: primary env write failed,"
232 " redundancy is lost!\n");
237 #endif /* CMD_SAVEENV */
239 #if defined(CONFIG_SPL_BUILD)
240 static int readenv(size_t offset
, u_char
*buf
)
242 return nand_spl_load_image(offset
, CONFIG_ENV_SIZE
, buf
);
245 static int readenv(size_t offset
, u_char
*buf
)
247 size_t end
= offset
+ CONFIG_ENV_RANGE
;
248 size_t amount_loaded
= 0;
249 size_t blocksize
, len
;
250 struct mtd_info
*mtd
;
253 mtd
= get_nand_dev_by_index(0);
257 blocksize
= mtd
->erasesize
;
258 len
= min(blocksize
, (size_t)CONFIG_ENV_SIZE
);
260 while (amount_loaded
< CONFIG_ENV_SIZE
&& offset
< end
) {
261 if (nand_block_isbad(mtd
, offset
)) {
264 char_ptr
= &buf
[amount_loaded
];
265 if (nand_read_skip_bad(mtd
, offset
,
267 mtd
->size
, char_ptr
))
271 amount_loaded
+= len
;
275 if (amount_loaded
!= CONFIG_ENV_SIZE
)
280 #endif /* #if defined(CONFIG_SPL_BUILD) */
282 #ifdef CONFIG_ENV_OFFSET_OOB
283 int get_nand_env_oob(struct mtd_info
*mtd
, unsigned long *result
)
285 struct mtd_oob_ops ops
;
286 uint32_t oob_buf
[ENV_OFFSET_SIZE
/ sizeof(uint32_t)];
290 ops
.mode
= MTD_OOB_AUTO
;
292 ops
.ooblen
= ENV_OFFSET_SIZE
;
293 ops
.oobbuf
= (void *)oob_buf
;
295 ret
= mtd
->read_oob(mtd
, ENV_OFFSET_SIZE
, &ops
);
297 printf("error reading OOB block 0\n");
301 if (oob_buf
[0] == ENV_OOB_MARKER
) {
302 *result
= ovoid ob_buf
[1] * mtd
->erasesize
;
303 } else if (oob_buf
[0] == ENV_OOB_MARKER_OLD
) {
304 *result
= oob_buf
[1];
306 printf("No dynamic environment marker in OOB block 0\n");
314 #ifdef CONFIG_ENV_OFFSET_REDUND
315 static int env_nand_load(void)
317 #if defined(ENV_IS_EMBEDDED)
320 int read1_fail
, read2_fail
;
321 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", 0);
333 read1_fail
= readenv(CONFIG_ENV_OFFSET
, (u_char
*) tmp_env1
);
334 read2_fail
= readenv(CONFIG_ENV_OFFSET_REDUND
, (u_char
*) tmp_env2
);
336 ret
= env_import_redund((char *)tmp_env1
, read1_fail
, (char *)tmp_env2
,
344 #endif /* ! ENV_IS_EMBEDDED */
346 #else /* ! CONFIG_ENV_OFFSET_REDUND */
348 * The legacy NAND code saved the environment in the first NAND
349 * device i.e., nand_dev_desc + 0. This is also the behaviour using
352 static int env_nand_load(void)
354 #if !defined(ENV_IS_EMBEDDED)
356 ALLOC_CACHE_ALIGN_BUFFER(char, buf
, CONFIG_ENV_SIZE
);
358 #if defined(CONFIG_ENV_OFFSET_OOB)
359 struct mtd_info
*mtd
= get_nand_dev_by_index(0);
361 * If unable to read environment offset from NAND OOB then fall through
362 * to the normal environment reading code below
364 if (mtd
&& !get_nand_env_oob(mtd
, &nand_env_oob_offset
)) {
365 printf("Found Environment offset in OOB..\n");
367 set_default_env("no env offset in OOB", 0);
372 ret
= readenv(CONFIG_ENV_OFFSET
, (u_char
*)buf
);
374 set_default_env("readenv() failed", 0);
378 return env_import(buf
, 1);
379 #endif /* ! ENV_IS_EMBEDDED */
383 #endif /* CONFIG_ENV_OFFSET_REDUND */
385 U_BOOT_ENV_LOCATION(nand
) = {
386 .location
= ENVL_NAND
,
388 .load
= env_nand_load
,
389 #if defined(CMD_SAVEENV)
390 .save
= env_save_ptr(env_nand_save
),
392 .init
= env_nand_init
,