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