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 * See file CREDITS for list of people who contributed to this
17 * This program is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU General Public License as
19 * published by the Free Software Foundation; either version 2 of
20 * the License, or (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program; if not, write to the Free Software
29 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
37 #include <environment.h>
38 #include <linux/stddef.h>
44 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
46 #elif defined(CONFIG_ENV_OFFSET_REDUND)
47 #error Cannot use CONFIG_ENV_OFFSET_REDUND without CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
50 #if defined(CONFIG_ENV_SIZE_REDUND) && (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
51 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
54 #ifndef CONFIG_ENV_RANGE
55 #define CONFIG_ENV_RANGE CONFIG_ENV_SIZE
58 char *env_name_spec = "NAND";
61 #if defined(ENV_IS_EMBEDDED)
62 env_t *env_ptr = &environment;
63 #elif defined(CONFIG_NAND_ENV_DST)
64 env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
65 #else /* ! ENV_IS_EMBEDDED */
67 #endif /* ENV_IS_EMBEDDED */
69 DECLARE_GLOBAL_DATA_PTR;
71 uchar env_get_char_spec (int index)
73 return ( *((uchar *)(gd->env_addr + index)) );
77 * This is called before nand_init() so we can't read NAND to
80 * Mark it OK for now. env_relocate() in env_common.c will call our
81 * relocate function which does the real validation.
83 * When using a NAND boot image (like sequoia_nand), the environment
84 * can be embedded or attached to the U-Boot image in NAND flash.
85 * This way the SPL loads not only the U-Boot image from NAND but
86 * also the environment.
90 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
91 int crc1_ok = 0, crc2_ok = 0;
94 #ifdef CONFIG_ENV_OFFSET_REDUND
97 tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
98 crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
103 crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
105 if (!crc1_ok && !crc2_ok) {
110 } else if (crc1_ok && !crc2_ok) {
113 #ifdef CONFIG_ENV_OFFSET_REDUND
114 else if (!crc1_ok && crc2_ok) {
117 /* both ok - check serial */
118 if(tmp_env1->flags == 255 && tmp_env2->flags == 0)
120 else if(tmp_env2->flags == 255 && tmp_env1->flags == 0)
122 else if(tmp_env1->flags > tmp_env2->flags)
124 else if(tmp_env2->flags > tmp_env1->flags)
126 else /* flags are equal - almost impossible */
130 if (gd->env_valid == 2)
134 if (gd->env_valid == 1)
137 gd->env_addr = (ulong)env_ptr->data;
139 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
140 gd->env_addr = (ulong)&default_environment[0];
142 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
149 * The legacy NAND code saved the environment in the first NAND device i.e.,
150 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
152 int writeenv(size_t offset, u_char *buf)
154 size_t end = offset + CONFIG_ENV_RANGE;
155 size_t amount_saved = 0;
156 size_t blocksize, len;
160 blocksize = nand_info[0].erasesize;
161 len = min(blocksize, CONFIG_ENV_SIZE);
163 while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
164 if (nand_block_isbad(&nand_info[0], offset)) {
167 char_ptr = &buf[amount_saved];
168 if (nand_write(&nand_info[0], offset, &len,
175 if (amount_saved != CONFIG_ENV_SIZE)
181 #ifdef CONFIG_ENV_OFFSET_REDUND
182 static unsigned char env_flags;
190 nand_erase_options_t nand_erase_options;
192 memset(&nand_erase_options, 0, sizeof(nand_erase_options));
193 nand_erase_options.length = CONFIG_ENV_RANGE;
195 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
198 res = (char *)&env_new.data;
199 len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
201 error("Cannot export environment: errno = %d\n", errno);
204 env_new.crc = crc32(0, env_new.data, ENV_SIZE);
205 env_new.flags = ++env_flags; /* increase the serial */
207 if(gd->env_valid == 1) {
208 puts("Erasing redundant NAND...\n");
209 nand_erase_options.offset = CONFIG_ENV_OFFSET_REDUND;
210 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
213 puts("Writing to redundant NAND... ");
214 ret = writeenv(CONFIG_ENV_OFFSET_REDUND,
217 puts("Erasing NAND...\n");
218 nand_erase_options.offset = CONFIG_ENV_OFFSET;
219 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
222 puts("Writing to NAND... ");
223 ret = writeenv(CONFIG_ENV_OFFSET,
233 gd->env_valid = (gd->env_valid == 2 ? 1 : 2);
237 #else /* ! CONFIG_ENV_OFFSET_REDUND */
244 nand_erase_options_t nand_erase_options;
246 memset(&nand_erase_options, 0, sizeof(nand_erase_options));
247 nand_erase_options.length = CONFIG_ENV_RANGE;
248 nand_erase_options.offset = CONFIG_ENV_OFFSET;
250 if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
253 res = (char *)&env_new.data;
254 len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
256 error("Cannot export environment: errno = %d\n", errno);
259 env_new.crc = crc32(0, env_new.data, ENV_SIZE);
261 puts("Erasing Nand...\n");
262 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
265 puts("Writing to Nand... ");
266 if (writeenv(CONFIG_ENV_OFFSET, (u_char *)&env_new)) {
274 #endif /* CONFIG_ENV_OFFSET_REDUND */
275 #endif /* CMD_SAVEENV */
277 int readenv(size_t offset, u_char * buf)
279 size_t end = offset + CONFIG_ENV_RANGE;
280 size_t amount_loaded = 0;
281 size_t blocksize, len;
285 blocksize = nand_info[0].erasesize;
288 len = min(blocksize, CONFIG_ENV_SIZE);
290 while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
291 if (nand_block_isbad(&nand_info[0], offset)) {
294 char_ptr = &buf[amount_loaded];
295 if (nand_read_skip_bad(&nand_info[0], offset, &len, char_ptr))
298 amount_loaded += len;
301 if (amount_loaded != CONFIG_ENV_SIZE)
307 #ifdef CONFIG_ENV_OFFSET_OOB
308 int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
310 struct mtd_oob_ops ops;
311 uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
315 ops.mode = MTD_OOB_AUTO;
317 ops.ooblen = ENV_OFFSET_SIZE;
318 ops.oobbuf = (void *) oob_buf;
320 ret = nand->read_oob(nand, ENV_OFFSET_SIZE, &ops);
322 printf("error reading OOB block 0\n");
326 if (oob_buf[0] == ENV_OOB_MARKER) {
327 *result = oob_buf[1] * nand->erasesize;
328 } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
329 *result = oob_buf[1];
331 printf("No dynamic environment marker in OOB block 0\n");
339 #ifdef CONFIG_ENV_OFFSET_REDUND
340 void env_relocate_spec(void)
342 #if !defined(ENV_IS_EMBEDDED)
343 int crc1_ok = 0, crc2_ok = 0;
344 env_t *ep, *tmp_env1, *tmp_env2;
346 tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
347 tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
349 if ((tmp_env1 == NULL) || (tmp_env2 == NULL)) {
350 puts("Can't allocate buffers for environment\n");
353 set_default_env("!malloc() failed");
357 if (readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1))
358 puts("No Valid Environment Area found\n");
360 if (readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2))
361 puts("No Valid Redundant Environment Area found\n");
363 crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
364 crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
366 if (!crc1_ok && !crc2_ok) {
369 set_default_env("!bad CRC");
371 } else if (crc1_ok && !crc2_ok) {
373 } else if (!crc1_ok && crc2_ok) {
376 /* both ok - check serial */
377 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
379 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
381 else if (tmp_env1->flags > tmp_env2->flags)
383 else if (tmp_env2->flags > tmp_env1->flags)
385 else /* flags are equal - almost impossible */
392 if (gd->env_valid == 1)
397 env_flags = ep->flags;
398 env_import((char *)ep, 0);
403 #endif /* ! ENV_IS_EMBEDDED */
405 #else /* ! CONFIG_ENV_OFFSET_REDUND */
407 * The legacy NAND code saved the environment in the first NAND
408 * device i.e., nand_dev_desc + 0. This is also the behaviour using
411 void env_relocate_spec (void)
413 #if !defined(ENV_IS_EMBEDDED)
415 char buf[CONFIG_ENV_SIZE];
417 #if defined(CONFIG_ENV_OFFSET_OOB)
418 ret = get_nand_env_oob(&nand_info[0], &nand_env_oob_offset);
420 * If unable to read environment offset from NAND OOB then fall through
421 * to the normal environment reading code below
424 printf("Found Environment offset in OOB..\n");
426 set_default_env("!no env offset in OOB");
431 ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
433 set_default_env("!readenv() failed");
438 #endif /* ! ENV_IS_EMBEDDED */
440 #endif /* CONFIG_ENV_OFFSET_REDUND */