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 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 #ifdef CONFIG_ENV_OFFSET_REDUND
156 static unsigned char env_flags;
164 nand_erase_options_t nand_erase_options;
166 memset(&nand_erase_options, 0, sizeof(nand_erase_options));
167 nand_erase_options.length = CONFIG_ENV_RANGE;
169 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
172 res = (char *)&env_new.data;
173 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
175 error("Cannot export environment: errno = %d\n", errno);
178 env_new.crc = crc32(0, env_new.data, ENV_SIZE);
179 env_new.flags = ++env_flags; /* increase the serial */
181 if (gd->env_valid == 1) {
182 puts("Erasing redundant NAND...\n");
183 nand_erase_options.offset = CONFIG_ENV_OFFSET_REDUND;
184 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
187 puts("Writing to redundant NAND... ");
188 ret = writeenv(CONFIG_ENV_OFFSET_REDUND, (u_char *)&env_new);
190 puts("Erasing NAND...\n");
191 nand_erase_options.offset = CONFIG_ENV_OFFSET;
192 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
195 puts("Writing to NAND... ");
196 ret = writeenv(CONFIG_ENV_OFFSET, (u_char *)&env_new);
205 gd->env_valid = gd->env_valid == 2 ? 1 : 2;
209 #else /* ! CONFIG_ENV_OFFSET_REDUND */
213 ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
216 nand_erase_options_t nand_erase_options;
218 memset(&nand_erase_options, 0, sizeof(nand_erase_options));
219 nand_erase_options.length = CONFIG_ENV_RANGE;
220 nand_erase_options.offset = CONFIG_ENV_OFFSET;
222 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
225 res = (char *)&env_new->data;
226 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
228 error("Cannot export environment: errno = %d\n", errno);
231 env_new->crc = crc32(0, env_new->data, ENV_SIZE);
233 puts("Erasing Nand...\n");
234 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
237 puts("Writing to Nand... ");
238 if (writeenv(CONFIG_ENV_OFFSET, (u_char *)env_new)) {
246 #endif /* CONFIG_ENV_OFFSET_REDUND */
247 #endif /* CMD_SAVEENV */
249 int readenv(size_t offset, u_char *buf)
251 size_t end = offset + CONFIG_ENV_RANGE;
252 size_t amount_loaded = 0;
253 size_t blocksize, len;
256 blocksize = nand_info[0].erasesize;
260 len = min(blocksize, CONFIG_ENV_SIZE);
262 while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
263 if (nand_block_isbad(&nand_info[0], offset)) {
266 char_ptr = &buf[amount_loaded];
267 if (nand_read_skip_bad(&nand_info[0], offset,
269 nand_info[0].size, char_ptr))
273 amount_loaded += len;
277 if (amount_loaded != CONFIG_ENV_SIZE)
283 #ifdef CONFIG_ENV_OFFSET_OOB
284 int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
286 struct mtd_oob_ops ops;
287 uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
291 ops.mode = MTD_OOB_AUTO;
293 ops.ooblen = ENV_OFFSET_SIZE;
294 ops.oobbuf = (void *)oob_buf;
296 ret = nand->read_oob(nand, ENV_OFFSET_SIZE, &ops);
298 printf("error reading OOB block 0\n");
302 if (oob_buf[0] == ENV_OOB_MARKER) {
303 *result = oob_buf[1] * nand->erasesize;
304 } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
305 *result = oob_buf[1];
307 printf("No dynamic environment marker in OOB block 0\n");
315 #ifdef CONFIG_ENV_OFFSET_REDUND
316 void env_relocate_spec(void)
318 #if !defined(ENV_IS_EMBEDDED)
319 int read1_fail = 0, read2_fail = 0;
320 int crc1_ok = 0, crc2_ok = 0;
321 env_t *ep, *tmp_env1, *tmp_env2;
323 tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
324 tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
325 if (tmp_env1 == NULL || tmp_env2 == NULL) {
326 puts("Can't allocate buffers for environment\n");
327 set_default_env("!malloc() failed");
331 read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
332 read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
334 if (read1_fail && read2_fail)
335 puts("*** Error - No Valid Environment Area found\n");
336 else if (read1_fail || read2_fail)
337 puts("*** Warning - some problems detected "
338 "reading environment; recovered successfully\n");
340 crc1_ok = !read1_fail &&
341 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
342 crc2_ok = !read2_fail &&
343 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
345 if (!crc1_ok && !crc2_ok) {
346 set_default_env("!bad CRC");
348 } else if (crc1_ok && !crc2_ok) {
350 } else if (!crc1_ok && crc2_ok) {
353 /* both ok - check serial */
354 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
356 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
358 else if (tmp_env1->flags > tmp_env2->flags)
360 else if (tmp_env2->flags > tmp_env1->flags)
362 else /* flags are equal - almost impossible */
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 */