]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/env_flash.c
board: axs103 - add maintainer information
[people/ms/u-boot.git] / common / env_flash.c
CommitLineData
c609719b 1/*
ea882baf 2 * (C) Copyright 2000-2010
c609719b
WD
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
3765b3e7 8 * SPDX-License-Identifier: GPL-2.0+
c609719b
WD
9 */
10
11/* #define DEBUG */
12
13#include <common.h>
c609719b
WD
14#include <command.h>
15#include <environment.h>
c609719b 16#include <linux/stddef.h>
47cd00fa 17#include <malloc.h>
ea882baf
WD
18#include <search.h>
19#include <errno.h>
c609719b 20
d87080b7
WD
21DECLARE_GLOBAL_DATA_PTR;
22
bdab39d3 23#if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_FLASH)
c609719b 24#define CMD_SAVEENV
0e8d1586 25#elif defined(CONFIG_ENV_ADDR_REDUND)
82b54b97 26#error CONFIG_ENV_ADDR_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_FLASH
c609719b
WD
27#endif
28
82b54b97
IG
29#if defined(CONFIG_ENV_SIZE_REDUND) && \
30 (CONFIG_ENV_SIZE_REDUND < CONFIG_ENV_SIZE)
0e8d1586 31#error CONFIG_ENV_SIZE_REDUND should not be less then CONFIG_ENV_SIZE
c609719b
WD
32#endif
33
82b54b97 34char *env_name_spec = "Flash";
c609719b
WD
35
36#ifdef ENV_IS_EMBEDDED
994bc671 37env_t *env_ptr = &environment;
c609719b 38
0e8d1586 39static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
c609719b
WD
40
41#else /* ! ENV_IS_EMBEDDED */
42
0e8d1586 43env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
0e8d1586 44static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
c609719b
WD
45#endif /* ENV_IS_EMBEDDED */
46
ea882baf
WD
47#if defined(CMD_SAVEENV) || defined(CONFIG_ENV_ADDR_REDUND)
48/* CONFIG_ENV_ADDR is supposed to be on sector boundary */
49static ulong end_addr = CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1;
50#endif
51
0e8d1586
JCPV
52#ifdef CONFIG_ENV_ADDR_REDUND
53static env_t *flash_addr_new = (env_t *)CONFIG_ENV_ADDR_REDUND;
c609719b 54
ea882baf 55/* CONFIG_ENV_ADDR_REDUND is supposed to be on sector boundary */
0e8d1586 56static ulong end_addr_new = CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1;
0e8d1586 57#endif /* CONFIG_ENV_ADDR_REDUND */
c609719b 58
c609719b 59
0e8d1586 60#ifdef CONFIG_ENV_ADDR_REDUND
82b54b97 61int env_init(void)
c609719b 62{
8ed96046 63 int crc1_ok = 0, crc2_ok = 0;
c609719b
WD
64
65 uchar flag1 = flash_addr->flags;
66 uchar flag2 = flash_addr_new->flags;
67
68 ulong addr_default = (ulong)&default_environment[0];
69 ulong addr1 = (ulong)&(flash_addr->data);
70 ulong addr2 = (ulong)&(flash_addr_new->data);
71
82b54b97
IG
72 crc1_ok = crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc;
73 crc2_ok =
74 crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc;
75
76 if (crc1_ok && !crc2_ok) {
77 gd->env_addr = addr1;
78 gd->env_valid = 1;
79 } else if (!crc1_ok && crc2_ok) {
80 gd->env_addr = addr2;
81 gd->env_valid = 1;
82 } else if (!crc1_ok && !crc2_ok) {
83 gd->env_addr = addr_default;
84 gd->env_valid = 0;
c3f9d493 85 } else if (flag1 == ACTIVE_FLAG && flag2 == OBSOLETE_FLAG) {
82b54b97
IG
86 gd->env_addr = addr1;
87 gd->env_valid = 1;
c3f9d493 88 } else if (flag1 == OBSOLETE_FLAG && flag2 == ACTIVE_FLAG) {
82b54b97
IG
89 gd->env_addr = addr2;
90 gd->env_valid = 1;
c3f9d493 91 } else if (flag1 == flag2) {
82b54b97
IG
92 gd->env_addr = addr1;
93 gd->env_valid = 2;
c3f9d493 94 } else if (flag1 == 0xFF) {
82b54b97
IG
95 gd->env_addr = addr1;
96 gd->env_valid = 2;
c3f9d493 97 } else if (flag2 == 0xFF) {
82b54b97
IG
98 gd->env_addr = addr2;
99 gd->env_valid = 2;
c609719b
WD
100 }
101
ea882baf 102 return 0;
c609719b
WD
103}
104
105#ifdef CMD_SAVEENV
106int saveenv(void)
107{
ea882baf 108 env_t env_new;
7ce1526e 109 char *saved_data = NULL;
ea882baf 110 char flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
82b54b97 111 int rc = 1;
0e8d1586 112#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
ea882baf 113 ulong up_data = 0;
500545cc 114#endif
c609719b 115
82b54b97 116 debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
c609719b 117
82b54b97 118 if (flash_sect_protect(0, (ulong)flash_addr, end_addr))
ea882baf 119 goto done;
c609719b 120
ea882baf 121 debug("Protect off %08lX ... %08lX\n",
c609719b
WD
122 (ulong)flash_addr_new, end_addr_new);
123
82b54b97 124 if (flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new))
ea882baf 125 goto done;
ea882baf 126
7ce1526e
MV
127 rc = env_export(&env_new);
128 if (rc)
129 return rc;
82b54b97 130 env_new.flags = new_flag;
c609719b 131
0e8d1586 132#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
82b54b97 133 up_data = end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE);
ea882baf 134 debug("Data to save 0x%lX\n", up_data);
47cd00fa 135 if (up_data) {
82b54b97
IG
136 saved_data = malloc(up_data);
137 if (saved_data == NULL) {
8bde7f77 138 printf("Unable to save the rest of sector (%ld)\n",
47cd00fa 139 up_data);
ea882baf 140 goto done;
47cd00fa 141 }
8bde7f77 142 memcpy(saved_data,
82b54b97
IG
143 (void *)((long)flash_addr_new + CONFIG_ENV_SIZE),
144 up_data);
ea882baf
WD
145 debug("Data (start 0x%lX, len 0x%lX) saved at 0x%p\n",
146 (long)flash_addr_new + CONFIG_ENV_SIZE,
147 up_data, saved_data);
47cd00fa
WD
148 }
149#endif
ea882baf 150 puts("Erasing Flash...");
82b54b97 151 debug(" %08lX ... %08lX ...", (ulong)flash_addr_new, end_addr_new);
c609719b 152
82b54b97 153 if (flash_sect_erase((ulong)flash_addr_new, end_addr_new))
ea882baf 154 goto done;
c609719b 155
ea882baf
WD
156 puts("Writing to Flash... ");
157 debug(" %08lX ... %08lX ...",
c609719b 158 (ulong)&(flash_addr_new->data),
82b54b97
IG
159 sizeof(env_ptr->data) + (ulong)&(flash_addr_new->data));
160 rc = flash_write((char *)&env_new, (ulong)flash_addr_new,
161 sizeof(env_new));
162 if (rc)
163 goto perror;
164
165 rc = flash_write(&flag, (ulong)&(flash_addr->flags),
166 sizeof(flash_addr->flags));
167 if (rc)
168 goto perror;
c609719b 169
0e8d1586 170#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
47cd00fa 171 if (up_data) { /* restore the rest of sector */
ea882baf
WD
172 debug("Restoring the rest of data to 0x%lX len 0x%lX\n",
173 (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
8bde7f77 174 if (flash_write(saved_data,
0e8d1586 175 (long)flash_addr_new + CONFIG_ENV_SIZE,
82b54b97
IG
176 up_data))
177 goto perror;
47cd00fa
WD
178 }
179#endif
ea882baf
WD
180 puts("done\n");
181
c609719b 182 {
82b54b97 183 env_t *etmp = flash_addr;
c609719b
WD
184 ulong ltmp = end_addr;
185
186 flash_addr = flash_addr_new;
187 flash_addr_new = etmp;
188
189 end_addr = end_addr_new;
190 end_addr_new = ltmp;
191 }
192
193 rc = 0;
82b54b97
IG
194 goto done;
195perror:
196 flash_perror(rc);
ea882baf 197done:
47cd00fa 198 if (saved_data)
ea882baf 199 free(saved_data);
c609719b 200 /* try to re-protect */
82b54b97
IG
201 flash_sect_protect(1, (ulong)flash_addr, end_addr);
202 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
c609719b
WD
203
204 return rc;
205}
206#endif /* CMD_SAVEENV */
207
0e8d1586 208#else /* ! CONFIG_ENV_ADDR_REDUND */
c609719b 209
82b54b97 210int env_init(void)
c609719b 211{
c609719b 212 if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
82b54b97
IG
213 gd->env_addr = (ulong)&(env_ptr->data);
214 gd->env_valid = 1;
215 return 0;
c609719b 216 }
9bb8b209 217
82b54b97
IG
218 gd->env_addr = (ulong)&default_environment[0];
219 gd->env_valid = 0;
ea882baf 220 return 0;
c609719b
WD
221}
222
223#ifdef CMD_SAVEENV
c609719b
WD
224int saveenv(void)
225{
ea882baf 226 env_t env_new;
ea882baf 227 int rc = 1;
3fa1981e 228 char *saved_data = NULL;
ea882baf
WD
229#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
230 ulong up_data = 0;
c609719b 231
82b54b97 232 up_data = end_addr + 1 - ((long)flash_addr + CONFIG_ENV_SIZE);
ea882baf
WD
233 debug("Data to save 0x%lx\n", up_data);
234 if (up_data) {
82b54b97
IG
235 saved_data = malloc(up_data);
236 if (saved_data == NULL) {
ea882baf
WD
237 printf("Unable to save the rest of sector (%ld)\n",
238 up_data);
239 goto done;
240 }
241 memcpy(saved_data,
242 (void *)((long)flash_addr + CONFIG_ENV_SIZE), up_data);
243 debug("Data (start 0x%lx, len 0x%lx) saved at 0x%lx\n",
244 (ulong)flash_addr + CONFIG_ENV_SIZE,
245 up_data,
246 (ulong)saved_data);
247 }
0e8d1586 248#endif /* CONFIG_ENV_SECT_SIZE */
c609719b 249
82b54b97 250 debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
c609719b 251
ea882baf
WD
252 if (flash_sect_protect(0, (long)flash_addr, end_addr))
253 goto done;
c609719b 254
7ce1526e
MV
255 rc = env_export(&env_new);
256 if (rc)
ea882baf 257 goto done;
c609719b 258
ea882baf
WD
259 puts("Erasing Flash...");
260 if (flash_sect_erase((long)flash_addr, end_addr))
261 goto done;
c609719b 262
ea882baf
WD
263 puts("Writing to Flash... ");
264 rc = flash_write((char *)&env_new, (long)flash_addr, CONFIG_ENV_SIZE);
82b54b97
IG
265 if (rc != 0)
266 goto perror;
267
ea882baf
WD
268#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
269 if (up_data) { /* restore the rest of sector */
270 debug("Restoring the rest of data to 0x%lx len 0x%lx\n",
271 (ulong)flash_addr + CONFIG_ENV_SIZE, up_data);
272 if (flash_write(saved_data,
273 (long)flash_addr + CONFIG_ENV_SIZE,
82b54b97
IG
274 up_data))
275 goto perror;
ea882baf
WD
276 }
277#endif
278 puts("done\n");
279 rc = 0;
82b54b97
IG
280 goto done;
281perror:
282 flash_perror(rc);
ea882baf
WD
283done:
284 if (saved_data)
285 free(saved_data);
c609719b 286 /* try to re-protect */
82b54b97 287 flash_sect_protect(1, (long)flash_addr, end_addr);
ea882baf 288 return rc;
c609719b 289}
c609719b
WD
290#endif /* CMD_SAVEENV */
291
0e8d1586 292#endif /* CONFIG_ENV_ADDR_REDUND */
c609719b 293
ea882baf 294void env_relocate_spec(void)
c609719b 295{
0e8d1586 296#ifdef CONFIG_ENV_ADDR_REDUND
c3f9d493 297 if (gd->env_addr != (ulong)&(flash_addr->data)) {
ea882baf 298 env_t *etmp = flash_addr;
c609719b
WD
299 ulong ltmp = end_addr;
300
301 flash_addr = flash_addr_new;
302 flash_addr_new = etmp;
303
304 end_addr = end_addr_new;
305 end_addr_new = ltmp;
306 }
307
c3f9d493 308 if (flash_addr_new->flags != OBSOLETE_FLAG &&
82b54b97 309 crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc) {
c3f9d493
WD
310 char flag = OBSOLETE_FLAG;
311
c609719b 312 gd->env_valid = 2;
ea882baf 313 flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new);
c3f9d493 314 flash_write(&flag,
8bde7f77
WD
315 (ulong)&(flash_addr_new->flags),
316 sizeof(flash_addr_new->flags));
ea882baf 317 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
c609719b
WD
318 }
319
c3f9d493
WD
320 if (flash_addr->flags != ACTIVE_FLAG &&
321 (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG) {
322 char flag = ACTIVE_FLAG;
323
c609719b 324 gd->env_valid = 2;
ea882baf 325 flash_sect_protect(0, (ulong)flash_addr, end_addr);
c3f9d493 326 flash_write(&flag,
8bde7f77
WD
327 (ulong)&(flash_addr->flags),
328 sizeof(flash_addr->flags));
ea882baf 329 flash_sect_protect(1, (ulong)flash_addr, end_addr);
c609719b
WD
330 }
331
332 if (gd->env_valid == 2)
82b54b97
IG
333 puts("*** Warning - some problems detected "
334 "reading environment; recovered successfully\n\n");
0e8d1586 335#endif /* CONFIG_ENV_ADDR_REDUND */
ea882baf
WD
336
337 env_import((char *)flash_addr, 1);
c609719b 338}