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