]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/env_flash.c
Coding Style cleanup: remove trailing white space
[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
WD
108 env_t env_new;
109 ssize_t len;
82b54b97 110 char *res, *saved_data = NULL;
ea882baf 111 char flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
82b54b97 112 int rc = 1;
0e8d1586 113#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
ea882baf 114 ulong up_data = 0;
500545cc 115#endif
c609719b 116
82b54b97 117 debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
c609719b 118
82b54b97 119 if (flash_sect_protect(0, (ulong)flash_addr, end_addr))
ea882baf 120 goto done;
c609719b 121
ea882baf 122 debug("Protect off %08lX ... %08lX\n",
c609719b
WD
123 (ulong)flash_addr_new, end_addr_new);
124
82b54b97 125 if (flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new))
ea882baf 126 goto done;
ea882baf
WD
127
128 res = (char *)&env_new.data;
be11235a 129 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
ea882baf
WD
130 if (len < 0) {
131 error("Cannot export environment: errno = %d\n", errno);
132 goto done;
c609719b 133 }
82b54b97
IG
134 env_new.crc = crc32(0, env_new.data, ENV_SIZE);
135 env_new.flags = new_flag;
c609719b 136
0e8d1586 137#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
82b54b97 138 up_data = end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE);
ea882baf 139 debug("Data to save 0x%lX\n", up_data);
47cd00fa 140 if (up_data) {
82b54b97
IG
141 saved_data = malloc(up_data);
142 if (saved_data == NULL) {
8bde7f77 143 printf("Unable to save the rest of sector (%ld)\n",
47cd00fa 144 up_data);
ea882baf 145 goto done;
47cd00fa 146 }
8bde7f77 147 memcpy(saved_data,
82b54b97
IG
148 (void *)((long)flash_addr_new + CONFIG_ENV_SIZE),
149 up_data);
ea882baf
WD
150 debug("Data (start 0x%lX, len 0x%lX) saved at 0x%p\n",
151 (long)flash_addr_new + CONFIG_ENV_SIZE,
152 up_data, saved_data);
47cd00fa
WD
153 }
154#endif
ea882baf 155 puts("Erasing Flash...");
82b54b97 156 debug(" %08lX ... %08lX ...", (ulong)flash_addr_new, end_addr_new);
c609719b 157
82b54b97 158 if (flash_sect_erase((ulong)flash_addr_new, end_addr_new))
ea882baf 159 goto done;
c609719b 160
ea882baf
WD
161 puts("Writing to Flash... ");
162 debug(" %08lX ... %08lX ...",
c609719b 163 (ulong)&(flash_addr_new->data),
82b54b97
IG
164 sizeof(env_ptr->data) + (ulong)&(flash_addr_new->data));
165 rc = flash_write((char *)&env_new, (ulong)flash_addr_new,
166 sizeof(env_new));
167 if (rc)
168 goto perror;
169
170 rc = flash_write(&flag, (ulong)&(flash_addr->flags),
171 sizeof(flash_addr->flags));
172 if (rc)
173 goto perror;
c609719b 174
0e8d1586 175#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
47cd00fa 176 if (up_data) { /* restore the rest of sector */
ea882baf
WD
177 debug("Restoring the rest of data to 0x%lX len 0x%lX\n",
178 (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
8bde7f77 179 if (flash_write(saved_data,
0e8d1586 180 (long)flash_addr_new + CONFIG_ENV_SIZE,
82b54b97
IG
181 up_data))
182 goto perror;
47cd00fa
WD
183 }
184#endif
ea882baf
WD
185 puts("done\n");
186
c609719b 187 {
82b54b97 188 env_t *etmp = flash_addr;
c609719b
WD
189 ulong ltmp = end_addr;
190
191 flash_addr = flash_addr_new;
192 flash_addr_new = etmp;
193
194 end_addr = end_addr_new;
195 end_addr_new = ltmp;
196 }
197
198 rc = 0;
82b54b97
IG
199 goto done;
200perror:
201 flash_perror(rc);
ea882baf 202done:
47cd00fa 203 if (saved_data)
ea882baf 204 free(saved_data);
c609719b 205 /* try to re-protect */
82b54b97
IG
206 flash_sect_protect(1, (ulong)flash_addr, end_addr);
207 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
c609719b
WD
208
209 return rc;
210}
211#endif /* CMD_SAVEENV */
212
0e8d1586 213#else /* ! CONFIG_ENV_ADDR_REDUND */
c609719b 214
82b54b97 215int env_init(void)
c609719b 216{
c609719b 217 if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
82b54b97
IG
218 gd->env_addr = (ulong)&(env_ptr->data);
219 gd->env_valid = 1;
220 return 0;
c609719b 221 }
9bb8b209 222
82b54b97
IG
223 gd->env_addr = (ulong)&default_environment[0];
224 gd->env_valid = 0;
ea882baf 225 return 0;
c609719b
WD
226}
227
228#ifdef CMD_SAVEENV
c609719b
WD
229int saveenv(void)
230{
ea882baf
WD
231 env_t env_new;
232 ssize_t len;
233 int rc = 1;
82b54b97 234 char *res, *saved_data = NULL;
ea882baf
WD
235#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
236 ulong up_data = 0;
c609719b 237
82b54b97 238 up_data = end_addr + 1 - ((long)flash_addr + CONFIG_ENV_SIZE);
ea882baf
WD
239 debug("Data to save 0x%lx\n", up_data);
240 if (up_data) {
82b54b97
IG
241 saved_data = malloc(up_data);
242 if (saved_data == NULL) {
ea882baf
WD
243 printf("Unable to save the rest of sector (%ld)\n",
244 up_data);
245 goto done;
246 }
247 memcpy(saved_data,
248 (void *)((long)flash_addr + CONFIG_ENV_SIZE), up_data);
249 debug("Data (start 0x%lx, len 0x%lx) saved at 0x%lx\n",
250 (ulong)flash_addr + CONFIG_ENV_SIZE,
251 up_data,
252 (ulong)saved_data);
253 }
0e8d1586 254#endif /* CONFIG_ENV_SECT_SIZE */
c609719b 255
82b54b97 256 debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
c609719b 257
ea882baf
WD
258 if (flash_sect_protect(0, (long)flash_addr, end_addr))
259 goto done;
c609719b 260
ea882baf 261 res = (char *)&env_new.data;
be11235a 262 len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
ea882baf
WD
263 if (len < 0) {
264 error("Cannot export environment: errno = %d\n", errno);
265 goto done;
266 }
267 env_new.crc = crc32(0, env_new.data, ENV_SIZE);
c609719b 268
ea882baf
WD
269 puts("Erasing Flash...");
270 if (flash_sect_erase((long)flash_addr, end_addr))
271 goto done;
c609719b 272
ea882baf
WD
273 puts("Writing to Flash... ");
274 rc = flash_write((char *)&env_new, (long)flash_addr, CONFIG_ENV_SIZE);
82b54b97
IG
275 if (rc != 0)
276 goto perror;
277
ea882baf
WD
278#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
279 if (up_data) { /* restore the rest of sector */
280 debug("Restoring the rest of data to 0x%lx len 0x%lx\n",
281 (ulong)flash_addr + CONFIG_ENV_SIZE, up_data);
282 if (flash_write(saved_data,
283 (long)flash_addr + CONFIG_ENV_SIZE,
82b54b97
IG
284 up_data))
285 goto perror;
ea882baf
WD
286 }
287#endif
288 puts("done\n");
289 rc = 0;
82b54b97
IG
290 goto done;
291perror:
292 flash_perror(rc);
ea882baf
WD
293done:
294 if (saved_data)
295 free(saved_data);
c609719b 296 /* try to re-protect */
82b54b97 297 flash_sect_protect(1, (long)flash_addr, end_addr);
ea882baf 298 return rc;
c609719b 299}
c609719b
WD
300#endif /* CMD_SAVEENV */
301
0e8d1586 302#endif /* CONFIG_ENV_ADDR_REDUND */
c609719b 303
ea882baf 304void env_relocate_spec(void)
c609719b 305{
0e8d1586 306#ifdef CONFIG_ENV_ADDR_REDUND
c3f9d493 307 if (gd->env_addr != (ulong)&(flash_addr->data)) {
ea882baf 308 env_t *etmp = flash_addr;
c609719b
WD
309 ulong ltmp = end_addr;
310
311 flash_addr = flash_addr_new;
312 flash_addr_new = etmp;
313
314 end_addr = end_addr_new;
315 end_addr_new = ltmp;
316 }
317
c3f9d493 318 if (flash_addr_new->flags != OBSOLETE_FLAG &&
82b54b97 319 crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc) {
c3f9d493
WD
320 char flag = OBSOLETE_FLAG;
321
c609719b 322 gd->env_valid = 2;
ea882baf 323 flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new);
c3f9d493 324 flash_write(&flag,
8bde7f77
WD
325 (ulong)&(flash_addr_new->flags),
326 sizeof(flash_addr_new->flags));
ea882baf 327 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
c609719b
WD
328 }
329
c3f9d493
WD
330 if (flash_addr->flags != ACTIVE_FLAG &&
331 (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG) {
332 char flag = ACTIVE_FLAG;
333
c609719b 334 gd->env_valid = 2;
ea882baf 335 flash_sect_protect(0, (ulong)flash_addr, end_addr);
c3f9d493 336 flash_write(&flag,
8bde7f77
WD
337 (ulong)&(flash_addr->flags),
338 sizeof(flash_addr->flags));
ea882baf 339 flash_sect_protect(1, (ulong)flash_addr, end_addr);
c609719b
WD
340 }
341
342 if (gd->env_valid == 2)
82b54b97
IG
343 puts("*** Warning - some problems detected "
344 "reading environment; recovered successfully\n\n");
0e8d1586 345#endif /* CONFIG_ENV_ADDR_REDUND */
ea882baf
WD
346
347 env_import((char *)flash_addr, 1);
c609719b 348}