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>
26 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
28 #elif defined(CONFIG_ENV_OFFSET_REDUND)
29 #error CONFIG_ENV_OFFSET_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
32 #if defined(CONFIG_ENV_SIZE_REDUND) && \
33 (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
34 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
37 #ifndef CONFIG_ENV_RANGE
38 #define CONFIG_ENV_RANGE CONFIG_ENV_SIZE
41 char *env_name_spec = "NAND";
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.
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) {
85 } else if (crc1_ok && !crc2_ok) {
88 #ifdef CONFIG_ENV_OFFSET_REDUND
89 else if (!crc1_ok && crc2_ok) {
92 /* both ok - check serial */
93 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
95 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
97 else if (tmp_env1->flags > tmp_env2->flags)
99 else if (tmp_env2->flags > tmp_env1->flags)
101 else /* flags are equal - almost impossible */
105 if (gd->env_valid == 2)
109 if (gd->env_valid == 1)
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];
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;
134 blocksize = nand_info[0].erasesize;
135 len = min(blocksize, CONFIG_ENV_SIZE);
137 while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
138 if (nand_block_isbad(&nand_info[0], offset)) {
141 char_ptr = &buf[amount_saved];
142 if (nand_write(&nand_info[0], offset, &len, char_ptr))
149 if (amount_saved != CONFIG_ENV_SIZE)
155 struct env_location {
157 const nand_erase_options_t erase_opts;
160 static int erase_and_write_env(const struct env_location *location,
165 printf("Erasing %s...\n", location->name);
166 if (nand_erase_opts(&nand_info[0], &location->erase_opts))
169 printf("Writing to %s... ", location->name);
170 ret = writeenv(location->erase_opts.offset, env_new);
171 puts(ret ? "FAILED!\n" : "OK\n");
176 #ifdef CONFIG_ENV_OFFSET_REDUND
177 static unsigned char env_flags;
183 ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
185 static const struct env_location location[] = {
189 .length = CONFIG_ENV_RANGE,
190 .offset = CONFIG_ENV_OFFSET,
193 #ifdef CONFIG_ENV_OFFSET_REDUND
195 .name = "redundant NAND",
197 .length = CONFIG_ENV_RANGE,
198 .offset = CONFIG_ENV_OFFSET_REDUND,
205 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
208 ret = env_export(env_new);
212 #ifdef CONFIG_ENV_OFFSET_REDUND
213 env_new->flags = ++env_flags; /* increase the serial */
214 env_idx = (gd->env_valid == 1);
217 ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
218 #ifdef CONFIG_ENV_OFFSET_REDUND
220 /* preset other copy for next write */
221 gd->env_valid = gd->env_valid == 2 ? 1 : 2;
225 env_idx = (env_idx + 1) & 1;
226 ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
228 printf("Warning: primary env write failed,"
229 " redundancy is lost!\n");
234 #endif /* CMD_SAVEENV */
236 static int readenv(size_t offset, u_char *buf)
238 size_t end = offset + CONFIG_ENV_RANGE;
239 size_t amount_loaded = 0;
240 size_t blocksize, len;
243 blocksize = nand_info[0].erasesize;
247 len = min(blocksize, CONFIG_ENV_SIZE);
249 while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
250 if (nand_block_isbad(&nand_info[0], offset)) {
253 char_ptr = &buf[amount_loaded];
254 if (nand_read_skip_bad(&nand_info[0], offset,
256 nand_info[0].size, char_ptr))
260 amount_loaded += len;
264 if (amount_loaded != CONFIG_ENV_SIZE)
270 #ifdef CONFIG_ENV_OFFSET_OOB
271 int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
273 struct mtd_oob_ops ops;
274 uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
278 ops.mode = MTD_OOB_AUTO;
280 ops.ooblen = ENV_OFFSET_SIZE;
281 ops.oobbuf = (void *)oob_buf;
283 ret = nand->read_oob(nand, ENV_OFFSET_SIZE, &ops);
285 printf("error reading OOB block 0\n");
289 if (oob_buf[0] == ENV_OOB_MARKER) {
290 *result = oob_buf[1] * nand->erasesize;
291 } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
292 *result = oob_buf[1];
294 printf("No dynamic environment marker in OOB block 0\n");
302 #ifdef CONFIG_ENV_OFFSET_REDUND
303 void env_relocate_spec(void)
305 #if !defined(ENV_IS_EMBEDDED)
306 int read1_fail = 0, read2_fail = 0;
307 int crc1_ok = 0, crc2_ok = 0;
308 env_t *ep, *tmp_env1, *tmp_env2;
310 tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
311 tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
312 if (tmp_env1 == NULL || tmp_env2 == NULL) {
313 puts("Can't allocate buffers for environment\n");
314 set_default_env("!malloc() failed");
318 read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
319 read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
321 if (read1_fail && read2_fail)
322 puts("*** Error - No Valid Environment Area found\n");
323 else if (read1_fail || read2_fail)
324 puts("*** Warning - some problems detected "
325 "reading environment; recovered successfully\n");
327 crc1_ok = !read1_fail &&
328 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
329 crc2_ok = !read2_fail &&
330 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
332 if (!crc1_ok && !crc2_ok) {
333 set_default_env("!bad CRC");
335 } else if (crc1_ok && !crc2_ok) {
337 } else if (!crc1_ok && crc2_ok) {
340 /* both ok - check serial */
341 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
343 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
345 else if (tmp_env1->flags > tmp_env2->flags)
347 else if (tmp_env2->flags > tmp_env1->flags)
349 else /* flags are equal - almost impossible */
355 if (gd->env_valid == 1)
360 env_flags = ep->flags;
361 env_import((char *)ep, 0);
367 #endif /* ! ENV_IS_EMBEDDED */
369 #else /* ! CONFIG_ENV_OFFSET_REDUND */
371 * The legacy NAND code saved the environment in the first NAND
372 * device i.e., nand_dev_desc + 0. This is also the behaviour using
375 void env_relocate_spec(void)
377 #if !defined(ENV_IS_EMBEDDED)
379 ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
381 #if defined(CONFIG_ENV_OFFSET_OOB)
382 ret = get_nand_env_oob(&nand_info[0], &nand_env_oob_offset);
384 * If unable to read environment offset from NAND OOB then fall through
385 * to the normal environment reading code below
388 printf("Found Environment offset in OOB..\n");
390 set_default_env("!no env offset in OOB");
395 ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
397 set_default_env("!readenv() failed");
402 #endif /* ! ENV_IS_EMBEDDED */
404 #endif /* CONFIG_ENV_OFFSET_REDUND */