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 #endif /* ENV_IS_EMBEDDED */
49 DECLARE_GLOBAL_DATA_PTR;
52 * This is called before nand_init() so we can't read NAND to
55 * Mark it OK for now. env_relocate() in env_common.c will call our
56 * relocate function which does the real validation.
58 * When using a NAND boot image (like sequoia_nand), the environment
59 * can be embedded or attached to the U-Boot image in NAND flash.
60 * This way the SPL loads not only the U-Boot image from NAND but
61 * also the environment.
65 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
66 int crc1_ok = 0, crc2_ok = 0;
69 #ifdef CONFIG_ENV_OFFSET_REDUND
72 tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
73 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
76 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
78 if (!crc1_ok && !crc2_ok) {
83 } else if (crc1_ok && !crc2_ok) {
86 #ifdef CONFIG_ENV_OFFSET_REDUND
87 else if (!crc1_ok && crc2_ok) {
90 /* both ok - check serial */
91 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
93 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
95 else if (tmp_env1->flags > tmp_env2->flags)
97 else if (tmp_env2->flags > tmp_env1->flags)
99 else /* flags are equal - almost impossible */
103 if (gd->env_valid == 2)
107 if (gd->env_valid == 1)
110 gd->env_addr = (ulong)env_ptr->data;
112 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
113 gd->env_addr = (ulong)&default_environment[0];
115 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
122 * The legacy NAND code saved the environment in the first NAND device i.e.,
123 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
125 int writeenv(size_t offset, u_char *buf)
127 size_t end = offset + CONFIG_ENV_RANGE;
128 size_t amount_saved = 0;
129 size_t blocksize, len;
132 blocksize = nand_info[0].erasesize;
133 len = min(blocksize, CONFIG_ENV_SIZE);
135 while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
136 if (nand_block_isbad(&nand_info[0], offset)) {
139 char_ptr = &buf[amount_saved];
140 if (nand_write(&nand_info[0], offset, &len, char_ptr))
147 if (amount_saved != CONFIG_ENV_SIZE)
153 #ifdef CONFIG_ENV_OFFSET_REDUND
154 static unsigned char env_flags;
162 nand_erase_options_t nand_erase_options;
164 memset(&nand_erase_options, 0, sizeof(nand_erase_options));
165 nand_erase_options.length = CONFIG_ENV_RANGE;
167 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
170 res = (char *)&env_new.data;
171 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
173 error("Cannot export environment: errno = %d\n", errno);
176 env_new.crc = crc32(0, env_new.data, ENV_SIZE);
177 env_new.flags = ++env_flags; /* increase the serial */
179 if (gd->env_valid == 1) {
180 puts("Erasing redundant NAND...\n");
181 nand_erase_options.offset = CONFIG_ENV_OFFSET_REDUND;
182 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
185 puts("Writing to redundant NAND... ");
186 ret = writeenv(CONFIG_ENV_OFFSET_REDUND, (u_char *)&env_new);
188 puts("Erasing NAND...\n");
189 nand_erase_options.offset = CONFIG_ENV_OFFSET;
190 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
193 puts("Writing to NAND... ");
194 ret = writeenv(CONFIG_ENV_OFFSET, (u_char *)&env_new);
203 gd->env_valid = gd->env_valid == 2 ? 1 : 2;
207 #else /* ! CONFIG_ENV_OFFSET_REDUND */
211 ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
214 nand_erase_options_t nand_erase_options;
216 memset(&nand_erase_options, 0, sizeof(nand_erase_options));
217 nand_erase_options.length = CONFIG_ENV_RANGE;
218 nand_erase_options.offset = CONFIG_ENV_OFFSET;
220 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
223 res = (char *)&env_new->data;
224 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
226 error("Cannot export environment: errno = %d\n", errno);
229 env_new->crc = crc32(0, env_new->data, ENV_SIZE);
231 puts("Erasing Nand...\n");
232 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
235 puts("Writing to Nand... ");
236 if (writeenv(CONFIG_ENV_OFFSET, (u_char *)env_new)) {
244 #endif /* CONFIG_ENV_OFFSET_REDUND */
245 #endif /* CMD_SAVEENV */
247 int readenv(size_t offset, u_char *buf)
249 size_t end = offset + CONFIG_ENV_RANGE;
250 size_t amount_loaded = 0;
251 size_t blocksize, len;
254 blocksize = nand_info[0].erasesize;
258 len = min(blocksize, CONFIG_ENV_SIZE);
260 while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
261 if (nand_block_isbad(&nand_info[0], offset)) {
264 char_ptr = &buf[amount_loaded];
265 if (nand_read_skip_bad(&nand_info[0], offset,
267 nand_info[0].size, char_ptr))
271 amount_loaded += len;
275 if (amount_loaded != CONFIG_ENV_SIZE)
281 #ifdef CONFIG_ENV_OFFSET_OOB
282 int get_nand_env_oob(nand_info_t *nand, 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 = nand->read_oob(nand, 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] * nand->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 */
364 #ifdef CONFIG_NAND_ENV_DST
368 if (gd->env_valid == 1)
373 env_flags = ep->flags;
374 env_import((char *)ep, 0);
380 #endif /* ! ENV_IS_EMBEDDED */
382 #else /* ! CONFIG_ENV_OFFSET_REDUND */
384 * The legacy NAND code saved the environment in the first NAND
385 * device i.e., nand_dev_desc + 0. This is also the behaviour using
388 void env_relocate_spec(void)
390 #if !defined(ENV_IS_EMBEDDED)
392 ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
394 #if defined(CONFIG_ENV_OFFSET_OOB)
395 ret = get_nand_env_oob(&nand_info[0], &nand_env_oob_offset);
397 * If unable to read environment offset from NAND OOB then fall through
398 * to the normal environment reading code below
401 printf("Found Environment offset in OOB..\n");
403 set_default_env("!no env offset in OOB");
408 ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
410 set_default_env("!readenv() failed");
415 #endif /* ! ENV_IS_EMBEDDED */
417 #endif /* CONFIG_ENV_OFFSET_REDUND */