3 * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
6 * Jian Zhang, Texas Instruments, jzhang@ti.com.
8 * (C) Copyright 2000-2006
9 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
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>
41 #include <asm/errno.h>
43 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
45 #elif defined(CONFIG_ENV_OFFSET_REDUND)
46 #error Cannot use CONFIG_ENV_OFFSET_REDUND without CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
49 #if defined(CONFIG_ENV_SIZE_REDUND) && (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
50 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
53 #ifndef CONFIG_ENV_RANGE
54 #define CONFIG_ENV_RANGE CONFIG_ENV_SIZE
57 /* references to names in env_common.c */
58 extern uchar default_environment
[];
60 char * env_name_spec
= "NAND";
63 #if defined(ENV_IS_EMBEDDED)
64 extern uchar environment
[];
65 env_t
*env_ptr
= (env_t
*)(&environment
[0]);
66 #elif defined(CONFIG_NAND_ENV_DST)
67 env_t
*env_ptr
= (env_t
*)CONFIG_NAND_ENV_DST
;
68 #else /* ! ENV_IS_EMBEDDED */
70 #endif /* ENV_IS_EMBEDDED */
74 #if !defined(ENV_IS_EMBEDDED)
75 static void use_default(void);
78 DECLARE_GLOBAL_DATA_PTR
;
80 uchar
env_get_char_spec (int index
)
82 return ( *((uchar
*)(gd
->env_addr
+ index
)) );
86 /* this is called before nand_init()
87 * so we can't read Nand to validate env data.
88 * Mark it OK for now. env_relocate() in env_common.c
89 * will call our relocate function which does the real
92 * When using a NAND boot image (like sequoia_nand), the environment
93 * can be embedded or attached to the U-Boot image in NAND flash. This way
94 * the SPL loads not only the U-Boot image from NAND but also the
99 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
100 int crc1_ok
= 0, crc2_ok
= 0;
103 #ifdef CONFIG_ENV_OFFSET_REDUND
106 tmp_env2
= (env_t
*)((ulong
)env_ptr
+ CONFIG_ENV_SIZE
);
107 crc2_ok
= (crc32(0, tmp_env2
->data
, ENV_SIZE
) == tmp_env2
->crc
);
112 crc1_ok
= (crc32(0, tmp_env1
->data
, ENV_SIZE
) == tmp_env1
->crc
);
114 if (!crc1_ok
&& !crc2_ok
) {
119 } else if (crc1_ok
&& !crc2_ok
) {
122 #ifdef CONFIG_ENV_OFFSET_REDUND
123 else if (!crc1_ok
&& crc2_ok
) {
126 /* both ok - check serial */
127 if(tmp_env1
->flags
== 255 && tmp_env2
->flags
== 0)
129 else if(tmp_env2
->flags
== 255 && tmp_env1
->flags
== 0)
131 else if(tmp_env1
->flags
> tmp_env2
->flags
)
133 else if(tmp_env2
->flags
> tmp_env1
->flags
)
135 else /* flags are equal - almost impossible */
139 if (gd
->env_valid
== 2)
143 if (gd
->env_valid
== 1)
146 gd
->env_addr
= (ulong
)env_ptr
->data
;
148 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
149 gd
->env_addr
= (ulong
)&default_environment
[0];
151 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
158 * The legacy NAND code saved the environment in the first NAND device i.e.,
159 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
161 int writeenv(size_t offset
, u_char
*buf
)
163 size_t end
= offset
+ CONFIG_ENV_RANGE
;
164 size_t amount_saved
= 0;
165 size_t blocksize
, len
;
169 blocksize
= nand_info
[0].erasesize
;
170 len
= min(blocksize
, CONFIG_ENV_SIZE
);
172 while (amount_saved
< CONFIG_ENV_SIZE
&& offset
< end
) {
173 if (nand_block_isbad(&nand_info
[0], offset
)) {
176 char_ptr
= &buf
[amount_saved
];
177 if (nand_write(&nand_info
[0], offset
, &len
,
184 if (amount_saved
!= CONFIG_ENV_SIZE
)
189 #ifdef CONFIG_ENV_OFFSET_REDUND
193 nand_erase_options_t nand_erase_options
;
197 nand_erase_options
.length
= CONFIG_ENV_RANGE
;
198 nand_erase_options
.quiet
= 0;
199 nand_erase_options
.jffs2
= 0;
200 nand_erase_options
.scrub
= 0;
202 if (CONFIG_ENV_RANGE
< CONFIG_ENV_SIZE
)
204 if(gd
->env_valid
== 1) {
205 puts ("Erasing redundant Nand...\n");
206 nand_erase_options
.offset
= CONFIG_ENV_OFFSET_REDUND
;
207 if (nand_erase_opts(&nand_info
[0], &nand_erase_options
))
210 puts ("Writing to redundant Nand... ");
211 ret
= writeenv(CONFIG_ENV_OFFSET_REDUND
, (u_char
*) env_ptr
);
213 puts ("Erasing Nand...\n");
214 nand_erase_options
.offset
= CONFIG_ENV_OFFSET
;
215 if (nand_erase_opts(&nand_info
[0], &nand_erase_options
))
218 puts ("Writing to Nand... ");
219 ret
= writeenv(CONFIG_ENV_OFFSET
, (u_char
*) env_ptr
);
227 gd
->env_valid
= (gd
->env_valid
== 2 ? 1 : 2);
230 #else /* ! CONFIG_ENV_OFFSET_REDUND */
234 nand_erase_options_t nand_erase_options
;
236 nand_erase_options
.length
= CONFIG_ENV_RANGE
;
237 nand_erase_options
.quiet
= 0;
238 nand_erase_options
.jffs2
= 0;
239 nand_erase_options
.scrub
= 0;
240 nand_erase_options
.offset
= CONFIG_ENV_OFFSET
;
242 if (CONFIG_ENV_RANGE
< CONFIG_ENV_SIZE
)
244 puts ("Erasing Nand...\n");
245 if (nand_erase_opts(&nand_info
[0], &nand_erase_options
))
248 puts ("Writing to Nand... ");
249 if (writeenv(CONFIG_ENV_OFFSET
, (u_char
*) env_ptr
)) {
257 #endif /* CONFIG_ENV_OFFSET_REDUND */
258 #endif /* CMD_SAVEENV */
260 int readenv (size_t offset
, u_char
* buf
)
262 size_t end
= offset
+ CONFIG_ENV_RANGE
;
263 size_t amount_loaded
= 0;
264 size_t blocksize
, len
;
268 blocksize
= nand_info
[0].erasesize
;
269 len
= min(blocksize
, CONFIG_ENV_SIZE
);
271 while (amount_loaded
< CONFIG_ENV_SIZE
&& offset
< end
) {
272 if (nand_block_isbad(&nand_info
[0], offset
)) {
275 char_ptr
= &buf
[amount_loaded
];
276 if (nand_read(&nand_info
[0], offset
, &len
, char_ptr
))
279 amount_loaded
+= len
;
282 if (amount_loaded
!= CONFIG_ENV_SIZE
)
288 #ifdef CONFIG_ENV_OFFSET_OOB
289 int get_nand_env_oob(nand_info_t
*nand
, unsigned long *result
)
291 struct mtd_oob_ops ops
;
292 uint32_t oob_buf
[ENV_OFFSET_SIZE
/sizeof(uint32_t)];
296 ops
.mode
= MTD_OOB_AUTO
;
298 ops
.ooblen
= ENV_OFFSET_SIZE
;
299 ops
.oobbuf
= (void *) oob_buf
;
301 ret
= nand
->read_oob(nand
, ENV_OFFSET_SIZE
, &ops
);
303 printf("error reading OOB block 0\n");
307 if (oob_buf
[0] == ENV_OOB_MARKER
) {
308 *result
= oob_buf
[1] * nand
->erasesize
;
309 } else if (oob_buf
[0] == ENV_OOB_MARKER_OLD
) {
310 *result
= oob_buf
[1];
312 printf("No dynamic environment marker in OOB block 0\n");
320 #ifdef CONFIG_ENV_OFFSET_REDUND
321 void env_relocate_spec (void)
323 #if !defined(ENV_IS_EMBEDDED)
324 int crc1_ok
= 0, crc2_ok
= 0;
325 env_t
*tmp_env1
, *tmp_env2
;
327 tmp_env1
= (env_t
*) malloc(CONFIG_ENV_SIZE
);
328 tmp_env2
= (env_t
*) malloc(CONFIG_ENV_SIZE
);
330 if ((tmp_env1
== NULL
) || (tmp_env2
== NULL
)) {
331 puts("Can't allocate buffers for environment\n");
334 return use_default();
337 if (readenv(CONFIG_ENV_OFFSET
, (u_char
*) tmp_env1
))
338 puts("No Valid Environment Area Found\n");
339 if (readenv(CONFIG_ENV_OFFSET_REDUND
, (u_char
*) tmp_env2
))
340 puts("No Valid Reundant Environment Area Found\n");
342 crc1_ok
= (crc32(0, tmp_env1
->data
, ENV_SIZE
) == tmp_env1
->crc
);
343 crc2_ok
= (crc32(0, tmp_env2
->data
, ENV_SIZE
) == tmp_env2
->crc
);
345 if(!crc1_ok
&& !crc2_ok
) {
348 return use_default();
349 } else if(crc1_ok
&& !crc2_ok
)
351 else if(!crc1_ok
&& crc2_ok
)
354 /* both ok - check serial */
355 if(tmp_env1
->flags
== 255 && tmp_env2
->flags
== 0)
357 else if(tmp_env2
->flags
== 255 && tmp_env1
->flags
== 0)
359 else if(tmp_env1
->flags
> tmp_env2
->flags
)
361 else if(tmp_env2
->flags
> tmp_env1
->flags
)
363 else /* flags are equal - almost impossible */
369 if(gd
->env_valid
== 1) {
377 #endif /* ! ENV_IS_EMBEDDED */
379 #else /* ! CONFIG_ENV_OFFSET_REDUND */
381 * The legacy NAND code saved the environment in the first NAND device i.e.,
382 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
384 void env_relocate_spec (void)
386 #if !defined(ENV_IS_EMBEDDED)
389 #if defined(CONFIG_ENV_OFFSET_OOB)
390 ret
= get_nand_env_oob(&nand_info
[0], &nand_env_oob_offset
);
391 /* If unable to read environment offset from NAND OOB then fall through
392 * to the normal environment reading code below
395 printf("Found Environment offset in OOB..\n");
397 return use_default();
400 ret
= readenv(CONFIG_ENV_OFFSET
, (u_char
*) env_ptr
);
402 return use_default();
404 if (crc32(0, env_ptr
->data
, ENV_SIZE
) != env_ptr
->crc
)
405 return use_default();
406 #endif /* ! ENV_IS_EMBEDDED */
408 #endif /* CONFIG_ENV_OFFSET_REDUND */
410 #if !defined(ENV_IS_EMBEDDED)
411 static void use_default()
413 puts ("*** Warning - bad CRC or NAND, using default environment\n\n");