]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/env_flash.c
Update .gitignore's: add some generated files
[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[];
c609719b
WD
86
87
88uchar env_get_char_spec (int index)
89{
c609719b
WD
90 return ( *((uchar *)(gd->env_addr + index)) );
91}
92
0e8d1586 93#ifdef CONFIG_ENV_ADDR_REDUND
c609719b
WD
94
95int env_init(void)
96{
8ed96046 97 int crc1_ok = 0, crc2_ok = 0;
c609719b
WD
98
99 uchar flag1 = flash_addr->flags;
100 uchar flag2 = flash_addr_new->flags;
101
102 ulong addr_default = (ulong)&default_environment[0];
103 ulong addr1 = (ulong)&(flash_addr->data);
104 ulong addr2 = (ulong)&(flash_addr_new->data);
105
8ed96046
WD
106 crc1_ok = (crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc);
107 crc2_ok = (crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc);
108
c3f9d493 109 if (crc1_ok && ! crc2_ok) {
c609719b
WD
110 gd->env_addr = addr1;
111 gd->env_valid = 1;
c3f9d493 112 } else if (! crc1_ok && crc2_ok) {
c609719b
WD
113 gd->env_addr = addr2;
114 gd->env_valid = 1;
c3f9d493 115 } else if (! crc1_ok && ! crc2_ok) {
c609719b
WD
116 gd->env_addr = addr_default;
117 gd->env_valid = 0;
c3f9d493 118 } else if (flag1 == ACTIVE_FLAG && flag2 == OBSOLETE_FLAG) {
c609719b
WD
119 gd->env_addr = addr1;
120 gd->env_valid = 1;
c3f9d493 121 } else if (flag1 == OBSOLETE_FLAG && flag2 == ACTIVE_FLAG) {
c609719b
WD
122 gd->env_addr = addr2;
123 gd->env_valid = 1;
c3f9d493 124 } else if (flag1 == flag2) {
c609719b
WD
125 gd->env_addr = addr1;
126 gd->env_valid = 2;
c3f9d493 127 } else if (flag1 == 0xFF) {
c609719b
WD
128 gd->env_addr = addr1;
129 gd->env_valid = 2;
c3f9d493 130 } else if (flag2 == 0xFF) {
c609719b
WD
131 gd->env_addr = addr2;
132 gd->env_valid = 2;
133 }
134
135 return (0);
136}
137
138#ifdef CMD_SAVEENV
139int saveenv(void)
140{
500545cc 141 char *saved_data = NULL;
c609719b 142 int rc = 1;
c3f9d493 143 char flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
0e8d1586 144#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
47cd00fa 145 ulong up_data = 0;
500545cc 146#endif
c609719b
WD
147
148 debug ("Protect off %08lX ... %08lX\n",
149 (ulong)flash_addr, end_addr);
150
151 if (flash_sect_protect (0, (ulong)flash_addr, end_addr)) {
152 goto Done;
153 }
154
155 debug ("Protect off %08lX ... %08lX\n",
156 (ulong)flash_addr_new, end_addr_new);
157
158 if (flash_sect_protect (0, (ulong)flash_addr_new, end_addr_new)) {
159 goto Done;
160 }
161
0e8d1586
JCPV
162#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
163 up_data = (end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE));
47cd00fa
WD
164 debug ("Data to save 0x%x\n", up_data);
165 if (up_data) {
166 if ((saved_data = malloc(up_data)) == NULL) {
8bde7f77 167 printf("Unable to save the rest of sector (%ld)\n",
47cd00fa
WD
168 up_data);
169 goto Done;
170 }
8bde7f77 171 memcpy(saved_data,
0e8d1586 172 (void *)((long)flash_addr_new + CONFIG_ENV_SIZE), up_data);
8bde7f77 173 debug ("Data (start 0x%x, len 0x%x) saved at 0x%x\n",
0e8d1586 174 (long)flash_addr_new + CONFIG_ENV_SIZE,
47cd00fa
WD
175 up_data, saved_data);
176 }
177#endif
c609719b
WD
178 puts ("Erasing Flash...");
179 debug (" %08lX ... %08lX ...",
180 (ulong)flash_addr_new, end_addr_new);
181
182 if (flash_sect_erase ((ulong)flash_addr_new, end_addr_new)) {
183 goto Done;
184 }
185
186 puts ("Writing to Flash... ");
187 debug (" %08lX ... %08lX ...",
188 (ulong)&(flash_addr_new->data),
189 sizeof(env_ptr->data)+(ulong)&(flash_addr_new->data));
77ddac94 190 if ((rc = flash_write((char *)env_ptr->data,
8bde7f77 191 (ulong)&(flash_addr_new->data),
c40b2956 192 sizeof(env_ptr->data))) ||
c40b2956 193 (rc = flash_write((char *)&(env_ptr->crc),
8bde7f77 194 (ulong)&(flash_addr_new->crc),
c40b2956 195 sizeof(env_ptr->crc))) ||
c3f9d493 196 (rc = flash_write(&flag,
8bde7f77 197 (ulong)&(flash_addr->flags),
c40b2956 198 sizeof(flash_addr->flags))) ||
c3f9d493 199 (rc = flash_write(&new_flag,
8bde7f77 200 (ulong)&(flash_addr_new->flags),
c40b2956 201 sizeof(flash_addr_new->flags))))
c609719b
WD
202 {
203 flash_perror (rc);
204 goto Done;
205 }
206 puts ("done\n");
207
0e8d1586 208#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
47cd00fa
WD
209 if (up_data) { /* restore the rest of sector */
210 debug ("Restoring the rest of data to 0x%x len 0x%x\n",
0e8d1586 211 (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
8bde7f77 212 if (flash_write(saved_data,
0e8d1586 213 (long)flash_addr_new + CONFIG_ENV_SIZE,
47cd00fa
WD
214 up_data)) {
215 flash_perror(rc);
216 goto Done;
217 }
218 }
219#endif
c609719b
WD
220 {
221 env_t * etmp = flash_addr;
222 ulong ltmp = end_addr;
223
224 flash_addr = flash_addr_new;
225 flash_addr_new = etmp;
226
227 end_addr = end_addr_new;
228 end_addr_new = ltmp;
229 }
230
231 rc = 0;
232Done:
233
47cd00fa
WD
234 if (saved_data)
235 free (saved_data);
c609719b
WD
236 /* try to re-protect */
237 (void) flash_sect_protect (1, (ulong)flash_addr, end_addr);
238 (void) flash_sect_protect (1, (ulong)flash_addr_new, end_addr_new);
239
240 return rc;
241}
242#endif /* CMD_SAVEENV */
243
0e8d1586 244#else /* ! CONFIG_ENV_ADDR_REDUND */
c609719b
WD
245
246int env_init(void)
247{
c609719b
WD
248 if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
249 gd->env_addr = (ulong)&(env_ptr->data);
250 gd->env_valid = 1;
8ed96046 251 return(0);
c609719b 252 }
9bb8b209 253
8ed96046
WD
254 gd->env_addr = (ulong)&default_environment[0];
255 gd->env_valid = 0;
c609719b
WD
256 return (0);
257}
258
259#ifdef CMD_SAVEENV
260
261int saveenv(void)
262{
263 int len, rc;
264 ulong end_addr;
265 ulong flash_sect_addr;
0e8d1586 266#if defined(CONFIG_ENV_SECT_SIZE) && (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE)
c609719b 267 ulong flash_offset;
0e8d1586 268 uchar env_buffer[CONFIG_ENV_SECT_SIZE];
c609719b 269#else
77ddac94 270 uchar *env_buffer = (uchar *)env_ptr;
0e8d1586 271#endif /* CONFIG_ENV_SECT_SIZE */
c609719b
WD
272 int rcode = 0;
273
0e8d1586 274#if defined(CONFIG_ENV_SECT_SIZE) && (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE)
c609719b 275
0e8d1586
JCPV
276 flash_offset = ((ulong)flash_addr) & (CONFIG_ENV_SECT_SIZE-1);
277 flash_sect_addr = ((ulong)flash_addr) & ~(CONFIG_ENV_SECT_SIZE-1);
c609719b
WD
278
279 debug ( "copy old content: "
280 "sect_addr: %08lX env_addr: %08lX offset: %08lX\n",
281 flash_sect_addr, (ulong)flash_addr, flash_offset);
282
283 /* copy old contents to temporary buffer */
0e8d1586 284 memcpy (env_buffer, (void *)flash_sect_addr, CONFIG_ENV_SECT_SIZE);
c609719b
WD
285
286 /* copy current environment to temporary buffer */
287 memcpy ((uchar *)((unsigned long)env_buffer + flash_offset),
288 env_ptr,
0e8d1586 289 CONFIG_ENV_SIZE);
c609719b 290
0e8d1586 291 len = CONFIG_ENV_SECT_SIZE;
c609719b
WD
292#else
293 flash_sect_addr = (ulong)flash_addr;
0e8d1586
JCPV
294 len = CONFIG_ENV_SIZE;
295#endif /* CONFIG_ENV_SECT_SIZE */
c609719b
WD
296
297#ifndef CONFIG_INFERNO
298 end_addr = flash_sect_addr + len - 1;
299#else
300 /* this is the last sector, and the size is hardcoded here */
301 /* otherwise we will get stack problems on loading 128 KB environment */
302 end_addr = flash_sect_addr + 0x20000 - 1;
303#endif
304
305 debug ("Protect off %08lX ... %08lX\n",
306 (ulong)flash_sect_addr, end_addr);
307
308 if (flash_sect_protect (0, flash_sect_addr, end_addr))
309 return 1;
310
311 puts ("Erasing Flash...");
312 if (flash_sect_erase (flash_sect_addr, end_addr))
313 return 1;
314
315 puts ("Writing to Flash... ");
77ddac94 316 rc = flash_write((char *)env_buffer, flash_sect_addr, len);
c609719b
WD
317 if (rc != 0) {
318 flash_perror (rc);
319 rcode = 1;
320 } else {
321 puts ("done\n");
322 }
323
324 /* try to re-protect */
325 (void) flash_sect_protect (1, flash_sect_addr, end_addr);
326 return rcode;
327}
328
329#endif /* CMD_SAVEENV */
330
0e8d1586 331#endif /* CONFIG_ENV_ADDR_REDUND */
c609719b
WD
332
333void env_relocate_spec (void)
334{
0e8d1586
JCPV
335#if !defined(ENV_IS_EMBEDDED) || defined(CONFIG_ENV_ADDR_REDUND)
336#ifdef CONFIG_ENV_ADDR_REDUND
c3f9d493 337 if (gd->env_addr != (ulong)&(flash_addr->data)) {
c609719b
WD
338 env_t * etmp = flash_addr;
339 ulong ltmp = end_addr;
340
341 flash_addr = flash_addr_new;
342 flash_addr_new = etmp;
343
344 end_addr = end_addr_new;
345 end_addr_new = ltmp;
346 }
347
c3f9d493 348 if (flash_addr_new->flags != OBSOLETE_FLAG &&
c609719b 349 crc32(0, flash_addr_new->data, ENV_SIZE) ==
c3f9d493
WD
350 flash_addr_new->crc) {
351 char flag = OBSOLETE_FLAG;
352
c609719b
WD
353 gd->env_valid = 2;
354 flash_sect_protect (0, (ulong)flash_addr_new, end_addr_new);
c3f9d493 355 flash_write(&flag,
8bde7f77
WD
356 (ulong)&(flash_addr_new->flags),
357 sizeof(flash_addr_new->flags));
c609719b
WD
358 flash_sect_protect (1, (ulong)flash_addr_new, end_addr_new);
359 }
360
c3f9d493
WD
361 if (flash_addr->flags != ACTIVE_FLAG &&
362 (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG) {
363 char flag = ACTIVE_FLAG;
364
c609719b
WD
365 gd->env_valid = 2;
366 flash_sect_protect (0, (ulong)flash_addr, end_addr);
c3f9d493 367 flash_write(&flag,
8bde7f77
WD
368 (ulong)&(flash_addr->flags),
369 sizeof(flash_addr->flags));
c609719b
WD
370 flash_sect_protect (1, (ulong)flash_addr, end_addr);
371 }
372
373 if (gd->env_valid == 2)
374 puts ("*** Warning - some problems detected "
375 "reading environment; recovered successfully\n\n");
0e8d1586 376#endif /* CONFIG_ENV_ADDR_REDUND */
4acc2a10 377#ifdef CMD_SAVEENV
0e8d1586 378 memcpy (env_ptr, (void*)flash_addr, CONFIG_ENV_SIZE);
4acc2a10 379#endif
0e8d1586 380#endif /* ! ENV_IS_EMBEDDED || CONFIG_ENV_ADDR_REDUND */
c609719b 381}