]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/env_flash.c
rename CONFIG_CMD_ENV to CONFIG_CMD_SAVEENV
[people/ms/u-boot.git] / common / env_flash.c
CommitLineData
c609719b
WD
1/*
2 * (C) Copyright 2000-2002
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4 *
5 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
6 * Andreas Heppel <aheppel@sysgo.de>
7
8 * See file CREDITS for list of people who contributed to this
9 * project.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of
14 * the License, or (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
24 * MA 02111-1307 USA
25 */
26
27/* #define DEBUG */
28
29#include <common.h>
c609719b
WD
30#include <command.h>
31#include <environment.h>
c609719b 32#include <linux/stddef.h>
47cd00fa 33#include <malloc.h>
c609719b 34
d87080b7
WD
35DECLARE_GLOBAL_DATA_PTR;
36
bdab39d3 37#if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_FLASH)
c609719b 38#define CMD_SAVEENV
0e8d1586 39#elif defined(CONFIG_ENV_ADDR_REDUND)
bdab39d3 40#error Cannot use CONFIG_ENV_ADDR_REDUND without CONFIG_CMD_SAVEENV & CONFIG_CMD_FLASH
c609719b
WD
41#endif
42
0e8d1586
JCPV
43#if defined(CONFIG_ENV_SIZE_REDUND) && (CONFIG_ENV_SIZE_REDUND < CONFIG_ENV_SIZE)
44#error CONFIG_ENV_SIZE_REDUND should not be less then CONFIG_ENV_SIZE
c609719b
WD
45#endif
46
47#ifdef CONFIG_INFERNO
0e8d1586
JCPV
48# ifdef CONFIG_ENV_ADDR_REDUND
49#error CONFIG_ENV_ADDR_REDUND is not implemented for CONFIG_INFERNO
c609719b
WD
50# endif
51#endif
52
53char * env_name_spec = "Flash";
54
55#ifdef ENV_IS_EMBEDDED
56
57extern uchar environment[];
58env_t *env_ptr = (env_t *)(&environment[0]);
59
60#ifdef CMD_SAVEENV
61/* static env_t *flash_addr = (env_t *)(&environment[0]);-broken on ARM-wd-*/
0e8d1586 62static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
c609719b
WD
63#endif
64
65#else /* ! ENV_IS_EMBEDDED */
66
0e8d1586 67env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
c609719b 68#ifdef CMD_SAVEENV
0e8d1586 69static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
c609719b
WD
70#endif
71
72#endif /* ENV_IS_EMBEDDED */
73
0e8d1586
JCPV
74#ifdef CONFIG_ENV_ADDR_REDUND
75static env_t *flash_addr_new = (env_t *)CONFIG_ENV_ADDR_REDUND;
c609719b 76
0e8d1586
JCPV
77/* CONFIG_ENV_ADDR is supposed to be on sector boundary */
78static ulong end_addr = CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1;
79static ulong end_addr_new = CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1;
c609719b 80
c3f9d493
WD
81#define ACTIVE_FLAG 1
82#define OBSOLETE_FLAG 0
0e8d1586 83#endif /* CONFIG_ENV_ADDR_REDUND */
c609719b
WD
84
85extern uchar default_environment[];
86extern int default_environment_size;
87
88
89uchar env_get_char_spec (int index)
90{
c609719b
WD
91 return ( *((uchar *)(gd->env_addr + index)) );
92}
93
0e8d1586 94#ifdef CONFIG_ENV_ADDR_REDUND
c609719b
WD
95
96int env_init(void)
97{
8ed96046 98 int crc1_ok = 0, crc2_ok = 0;
c609719b
WD
99
100 uchar flag1 = flash_addr->flags;
101 uchar flag2 = flash_addr_new->flags;
102
103 ulong addr_default = (ulong)&default_environment[0];
104 ulong addr1 = (ulong)&(flash_addr->data);
105 ulong addr2 = (ulong)&(flash_addr_new->data);
106
8ed96046
WD
107 crc1_ok = (crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc);
108 crc2_ok = (crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc);
109
c3f9d493 110 if (crc1_ok && ! crc2_ok) {
c609719b
WD
111 gd->env_addr = addr1;
112 gd->env_valid = 1;
c3f9d493 113 } else if (! crc1_ok && crc2_ok) {
c609719b
WD
114 gd->env_addr = addr2;
115 gd->env_valid = 1;
c3f9d493 116 } else if (! crc1_ok && ! crc2_ok) {
c609719b
WD
117 gd->env_addr = addr_default;
118 gd->env_valid = 0;
c3f9d493 119 } else if (flag1 == ACTIVE_FLAG && flag2 == OBSOLETE_FLAG) {
c609719b
WD
120 gd->env_addr = addr1;
121 gd->env_valid = 1;
c3f9d493 122 } else if (flag1 == OBSOLETE_FLAG && flag2 == ACTIVE_FLAG) {
c609719b
WD
123 gd->env_addr = addr2;
124 gd->env_valid = 1;
c3f9d493 125 } else if (flag1 == flag2) {
c609719b
WD
126 gd->env_addr = addr1;
127 gd->env_valid = 2;
c3f9d493 128 } else if (flag1 == 0xFF) {
c609719b
WD
129 gd->env_addr = addr1;
130 gd->env_valid = 2;
c3f9d493 131 } else if (flag2 == 0xFF) {
c609719b
WD
132 gd->env_addr = addr2;
133 gd->env_valid = 2;
134 }
135
136 return (0);
137}
138
139#ifdef CMD_SAVEENV
140int saveenv(void)
141{
500545cc 142 char *saved_data = NULL;
c609719b 143 int rc = 1;
c3f9d493 144 char flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
0e8d1586 145#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
47cd00fa 146 ulong up_data = 0;
500545cc 147#endif
c609719b
WD
148
149 debug ("Protect off %08lX ... %08lX\n",
150 (ulong)flash_addr, end_addr);
151
152 if (flash_sect_protect (0, (ulong)flash_addr, end_addr)) {
153 goto Done;
154 }
155
156 debug ("Protect off %08lX ... %08lX\n",
157 (ulong)flash_addr_new, end_addr_new);
158
159 if (flash_sect_protect (0, (ulong)flash_addr_new, end_addr_new)) {
160 goto Done;
161 }
162
0e8d1586
JCPV
163#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
164 up_data = (end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE));
47cd00fa
WD
165 debug ("Data to save 0x%x\n", up_data);
166 if (up_data) {
167 if ((saved_data = malloc(up_data)) == NULL) {
8bde7f77 168 printf("Unable to save the rest of sector (%ld)\n",
47cd00fa
WD
169 up_data);
170 goto Done;
171 }
8bde7f77 172 memcpy(saved_data,
0e8d1586 173 (void *)((long)flash_addr_new + CONFIG_ENV_SIZE), up_data);
8bde7f77 174 debug ("Data (start 0x%x, len 0x%x) saved at 0x%x\n",
0e8d1586 175 (long)flash_addr_new + CONFIG_ENV_SIZE,
47cd00fa
WD
176 up_data, saved_data);
177 }
178#endif
c609719b
WD
179 puts ("Erasing Flash...");
180 debug (" %08lX ... %08lX ...",
181 (ulong)flash_addr_new, end_addr_new);
182
183 if (flash_sect_erase ((ulong)flash_addr_new, end_addr_new)) {
184 goto Done;
185 }
186
187 puts ("Writing to Flash... ");
188 debug (" %08lX ... %08lX ...",
189 (ulong)&(flash_addr_new->data),
190 sizeof(env_ptr->data)+(ulong)&(flash_addr_new->data));
77ddac94 191 if ((rc = flash_write((char *)env_ptr->data,
8bde7f77 192 (ulong)&(flash_addr_new->data),
c40b2956 193 sizeof(env_ptr->data))) ||
c40b2956 194 (rc = flash_write((char *)&(env_ptr->crc),
8bde7f77 195 (ulong)&(flash_addr_new->crc),
c40b2956 196 sizeof(env_ptr->crc))) ||
c3f9d493 197 (rc = flash_write(&flag,
8bde7f77 198 (ulong)&(flash_addr->flags),
c40b2956 199 sizeof(flash_addr->flags))) ||
c3f9d493 200 (rc = flash_write(&new_flag,
8bde7f77 201 (ulong)&(flash_addr_new->flags),
c40b2956 202 sizeof(flash_addr_new->flags))))
c609719b
WD
203 {
204 flash_perror (rc);
205 goto Done;
206 }
207 puts ("done\n");
208
0e8d1586 209#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
47cd00fa
WD
210 if (up_data) { /* restore the rest of sector */
211 debug ("Restoring the rest of data to 0x%x len 0x%x\n",
0e8d1586 212 (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
8bde7f77 213 if (flash_write(saved_data,
0e8d1586 214 (long)flash_addr_new + CONFIG_ENV_SIZE,
47cd00fa
WD
215 up_data)) {
216 flash_perror(rc);
217 goto Done;
218 }
219 }
220#endif
c609719b
WD
221 {
222 env_t * etmp = flash_addr;
223 ulong ltmp = end_addr;
224
225 flash_addr = flash_addr_new;
226 flash_addr_new = etmp;
227
228 end_addr = end_addr_new;
229 end_addr_new = ltmp;
230 }
231
232 rc = 0;
233Done:
234
47cd00fa
WD
235 if (saved_data)
236 free (saved_data);
c609719b
WD
237 /* try to re-protect */
238 (void) flash_sect_protect (1, (ulong)flash_addr, end_addr);
239 (void) flash_sect_protect (1, (ulong)flash_addr_new, end_addr_new);
240
241 return rc;
242}
243#endif /* CMD_SAVEENV */
244
0e8d1586 245#else /* ! CONFIG_ENV_ADDR_REDUND */
c609719b
WD
246
247int env_init(void)
248{
c609719b
WD
249 if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
250 gd->env_addr = (ulong)&(env_ptr->data);
251 gd->env_valid = 1;
8ed96046 252 return(0);
c609719b 253 }
9bb8b209 254
8ed96046
WD
255 gd->env_addr = (ulong)&default_environment[0];
256 gd->env_valid = 0;
c609719b
WD
257 return (0);
258}
259
260#ifdef CMD_SAVEENV
261
262int saveenv(void)
263{
264 int len, rc;
265 ulong end_addr;
266 ulong flash_sect_addr;
0e8d1586 267#if defined(CONFIG_ENV_SECT_SIZE) && (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE)
c609719b 268 ulong flash_offset;
0e8d1586 269 uchar env_buffer[CONFIG_ENV_SECT_SIZE];
c609719b 270#else
77ddac94 271 uchar *env_buffer = (uchar *)env_ptr;
0e8d1586 272#endif /* CONFIG_ENV_SECT_SIZE */
c609719b
WD
273 int rcode = 0;
274
0e8d1586 275#if defined(CONFIG_ENV_SECT_SIZE) && (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE)
c609719b 276
0e8d1586
JCPV
277 flash_offset = ((ulong)flash_addr) & (CONFIG_ENV_SECT_SIZE-1);
278 flash_sect_addr = ((ulong)flash_addr) & ~(CONFIG_ENV_SECT_SIZE-1);
c609719b
WD
279
280 debug ( "copy old content: "
281 "sect_addr: %08lX env_addr: %08lX offset: %08lX\n",
282 flash_sect_addr, (ulong)flash_addr, flash_offset);
283
284 /* copy old contents to temporary buffer */
0e8d1586 285 memcpy (env_buffer, (void *)flash_sect_addr, CONFIG_ENV_SECT_SIZE);
c609719b
WD
286
287 /* copy current environment to temporary buffer */
288 memcpy ((uchar *)((unsigned long)env_buffer + flash_offset),
289 env_ptr,
0e8d1586 290 CONFIG_ENV_SIZE);
c609719b 291
0e8d1586 292 len = CONFIG_ENV_SECT_SIZE;
c609719b
WD
293#else
294 flash_sect_addr = (ulong)flash_addr;
0e8d1586
JCPV
295 len = CONFIG_ENV_SIZE;
296#endif /* CONFIG_ENV_SECT_SIZE */
c609719b
WD
297
298#ifndef CONFIG_INFERNO
299 end_addr = flash_sect_addr + len - 1;
300#else
301 /* this is the last sector, and the size is hardcoded here */
302 /* otherwise we will get stack problems on loading 128 KB environment */
303 end_addr = flash_sect_addr + 0x20000 - 1;
304#endif
305
306 debug ("Protect off %08lX ... %08lX\n",
307 (ulong)flash_sect_addr, end_addr);
308
309 if (flash_sect_protect (0, flash_sect_addr, end_addr))
310 return 1;
311
312 puts ("Erasing Flash...");
313 if (flash_sect_erase (flash_sect_addr, end_addr))
314 return 1;
315
316 puts ("Writing to Flash... ");
77ddac94 317 rc = flash_write((char *)env_buffer, flash_sect_addr, len);
c609719b
WD
318 if (rc != 0) {
319 flash_perror (rc);
320 rcode = 1;
321 } else {
322 puts ("done\n");
323 }
324
325 /* try to re-protect */
326 (void) flash_sect_protect (1, flash_sect_addr, end_addr);
327 return rcode;
328}
329
330#endif /* CMD_SAVEENV */
331
0e8d1586 332#endif /* CONFIG_ENV_ADDR_REDUND */
c609719b
WD
333
334void env_relocate_spec (void)
335{
0e8d1586
JCPV
336#if !defined(ENV_IS_EMBEDDED) || defined(CONFIG_ENV_ADDR_REDUND)
337#ifdef CONFIG_ENV_ADDR_REDUND
c3f9d493 338 if (gd->env_addr != (ulong)&(flash_addr->data)) {
c609719b
WD
339 env_t * etmp = flash_addr;
340 ulong ltmp = end_addr;
341
342 flash_addr = flash_addr_new;
343 flash_addr_new = etmp;
344
345 end_addr = end_addr_new;
346 end_addr_new = ltmp;
347 }
348
c3f9d493 349 if (flash_addr_new->flags != OBSOLETE_FLAG &&
c609719b 350 crc32(0, flash_addr_new->data, ENV_SIZE) ==
c3f9d493
WD
351 flash_addr_new->crc) {
352 char flag = OBSOLETE_FLAG;
353
c609719b
WD
354 gd->env_valid = 2;
355 flash_sect_protect (0, (ulong)flash_addr_new, end_addr_new);
c3f9d493 356 flash_write(&flag,
8bde7f77
WD
357 (ulong)&(flash_addr_new->flags),
358 sizeof(flash_addr_new->flags));
c609719b
WD
359 flash_sect_protect (1, (ulong)flash_addr_new, end_addr_new);
360 }
361
c3f9d493
WD
362 if (flash_addr->flags != ACTIVE_FLAG &&
363 (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG) {
364 char flag = ACTIVE_FLAG;
365
c609719b
WD
366 gd->env_valid = 2;
367 flash_sect_protect (0, (ulong)flash_addr, end_addr);
c3f9d493 368 flash_write(&flag,
8bde7f77
WD
369 (ulong)&(flash_addr->flags),
370 sizeof(flash_addr->flags));
c609719b
WD
371 flash_sect_protect (1, (ulong)flash_addr, end_addr);
372 }
373
374 if (gd->env_valid == 2)
375 puts ("*** Warning - some problems detected "
376 "reading environment; recovered successfully\n\n");
0e8d1586 377#endif /* CONFIG_ENV_ADDR_REDUND */
4acc2a10 378#ifdef CMD_SAVEENV
0e8d1586 379 memcpy (env_ptr, (void*)flash_addr, CONFIG_ENV_SIZE);
4acc2a10 380#endif
0e8d1586 381#endif /* ! ENV_IS_EMBEDDED || CONFIG_ENV_ADDR_REDUND */
c609719b 382}