1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2010
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
7 * Andreas Heppel <aheppel@sysgo.de>
15 #include <env_internal.h>
16 #include <linux/stddef.h>
20 #include <u-boot/crc.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 #ifndef CONFIG_SPL_BUILD
25 # if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_FLASH)
27 # elif defined(CONFIG_ENV_ADDR_REDUND)
28 # error CONFIG_ENV_ADDR_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_FLASH
32 /* TODO(sjg@chromium.org): Figure out all these special cases */
33 #if (!defined(CONFIG_MICROBLAZE) && !defined(CONFIG_ARCH_ZYNQ) && \
34 !defined(CONFIG_TARGET_MCCMON6) && !defined(CONFIG_TARGET_X600) && \
35 !defined(CONFIG_TARGET_EDMINIV2)) || \
36 !defined(CONFIG_SPL_BUILD)
40 #if !defined(CONFIG_TARGET_X600) || !defined(CONFIG_SPL_BUILD)
44 #if defined(CONFIG_ENV_ADDR_REDUND) && defined(CMD_SAVEENV) || \
45 !defined(CONFIG_ENV_ADDR_REDUND) && defined(INITENV)
46 #ifdef ENV_IS_EMBEDDED
47 static env_t *env_ptr = &embedded_environment;
48 #else /* ! ENV_IS_EMBEDDED */
50 static env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
51 #endif /* ENV_IS_EMBEDDED */
53 static __maybe_unused env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
55 /* CONFIG_ENV_ADDR is supposed to be on sector boundary */
56 static ulong __maybe_unused end_addr =
57 CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1;
59 #ifdef CONFIG_ENV_ADDR_REDUND
61 static env_t __maybe_unused *flash_addr_new = (env_t *)CONFIG_ENV_ADDR_REDUND;
63 /* CONFIG_ENV_ADDR_REDUND is supposed to be on sector boundary */
64 static ulong __maybe_unused end_addr_new =
65 CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1;
66 #endif /* CONFIG_ENV_ADDR_REDUND */
68 #ifdef CONFIG_ENV_ADDR_REDUND
70 static int env_flash_init(void)
72 int crc1_ok = 0, crc2_ok = 0;
74 uchar flag1 = flash_addr->flags;
75 uchar flag2 = flash_addr_new->flags;
77 ulong addr_default = (ulong)&default_environment[0];
78 ulong addr1 = (ulong)&(flash_addr->data);
79 ulong addr2 = (ulong)&(flash_addr_new->data);
81 crc1_ok = crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc;
83 crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc;
85 if (crc1_ok && !crc2_ok) {
87 gd->env_valid = ENV_VALID;
88 } else if (!crc1_ok && crc2_ok) {
90 gd->env_valid = ENV_VALID;
91 } else if (!crc1_ok && !crc2_ok) {
92 gd->env_addr = addr_default;
93 gd->env_valid = ENV_INVALID;
94 } else if (flag1 == ENV_REDUND_ACTIVE &&
95 flag2 == ENV_REDUND_OBSOLETE) {
97 gd->env_valid = ENV_VALID;
98 } else if (flag1 == ENV_REDUND_OBSOLETE &&
99 flag2 == ENV_REDUND_ACTIVE) {
100 gd->env_addr = addr2;
101 gd->env_valid = ENV_VALID;
102 } else if (flag1 == flag2) {
103 gd->env_addr = addr1;
104 gd->env_valid = ENV_REDUND;
105 } else if (flag1 == 0xFF) {
106 gd->env_addr = addr1;
107 gd->env_valid = ENV_REDUND;
108 } else if (flag2 == 0xFF) {
109 gd->env_addr = addr2;
110 gd->env_valid = ENV_REDUND;
118 static int env_flash_save(void)
121 char *saved_data = NULL;
122 char flag = ENV_REDUND_OBSOLETE, new_flag = ENV_REDUND_ACTIVE;
124 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
128 debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
130 if (flash_sect_protect(0, (ulong)flash_addr, end_addr))
133 debug("Protect off %08lX ... %08lX\n",
134 (ulong)flash_addr_new, end_addr_new);
136 if (flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new))
139 rc = env_export(&env_new);
142 env_new.flags = new_flag;
144 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
145 up_data = end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE);
146 debug("Data to save 0x%lX\n", up_data);
148 saved_data = malloc(up_data);
149 if (saved_data == NULL) {
150 printf("Unable to save the rest of sector (%ld)\n",
155 (void *)((long)flash_addr_new + CONFIG_ENV_SIZE),
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);
162 puts("Erasing Flash...");
163 debug(" %08lX ... %08lX ...", (ulong)flash_addr_new, end_addr_new);
165 if (flash_sect_erase((ulong)flash_addr_new, end_addr_new))
168 puts("Writing to Flash... ");
169 debug(" %08lX ... %08lX ...",
170 (ulong)&(flash_addr_new->data),
171 sizeof(env_ptr->data) + (ulong)&(flash_addr_new->data));
172 rc = flash_write((char *)&env_new, (ulong)flash_addr_new,
177 rc = flash_write(&flag, (ulong)&(flash_addr->flags),
178 sizeof(flash_addr->flags));
182 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
183 if (up_data) { /* restore the rest of sector */
184 debug("Restoring the rest of data to 0x%lX len 0x%lX\n",
185 (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
186 if (flash_write(saved_data,
187 (long)flash_addr_new + CONFIG_ENV_SIZE,
195 env_t *etmp = flash_addr;
196 ulong ltmp = end_addr;
198 flash_addr = flash_addr_new;
199 flash_addr_new = etmp;
201 end_addr = end_addr_new;
212 /* try to re-protect */
213 flash_sect_protect(1, (ulong)flash_addr, end_addr);
214 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
218 #endif /* CMD_SAVEENV */
220 #else /* ! CONFIG_ENV_ADDR_REDUND */
223 static int env_flash_init(void)
225 if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
226 gd->env_addr = (ulong)&(env_ptr->data);
227 gd->env_valid = ENV_VALID;
231 gd->env_addr = (ulong)&default_environment[0];
232 gd->env_valid = ENV_INVALID;
238 static int env_flash_save(void)
242 char *saved_data = NULL;
243 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
246 up_data = end_addr + 1 - ((long)flash_addr + CONFIG_ENV_SIZE);
247 debug("Data to save 0x%lx\n", up_data);
249 saved_data = malloc(up_data);
250 if (saved_data == NULL) {
251 printf("Unable to save the rest of sector (%ld)\n",
256 (void *)((long)flash_addr + CONFIG_ENV_SIZE), up_data);
257 debug("Data (start 0x%lx, len 0x%lx) saved at 0x%lx\n",
258 (ulong)flash_addr + CONFIG_ENV_SIZE,
262 #endif /* CONFIG_ENV_SECT_SIZE */
264 debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
266 if (flash_sect_protect(0, (long)flash_addr, end_addr))
269 rc = env_export(&env_new);
273 puts("Erasing Flash...");
274 if (flash_sect_erase((long)flash_addr, end_addr))
277 puts("Writing to Flash... ");
278 rc = flash_write((char *)&env_new, (long)flash_addr, CONFIG_ENV_SIZE);
282 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
283 if (up_data) { /* restore the rest of sector */
284 debug("Restoring the rest of data to 0x%lx len 0x%lx\n",
285 (ulong)flash_addr + CONFIG_ENV_SIZE, up_data);
286 if (flash_write(saved_data,
287 (long)flash_addr + CONFIG_ENV_SIZE,
300 /* try to re-protect */
301 flash_sect_protect(1, (long)flash_addr, end_addr);
304 #endif /* CMD_SAVEENV */
306 #endif /* CONFIG_ENV_ADDR_REDUND */
309 static int env_flash_load(void)
311 #ifdef CONFIG_ENV_ADDR_REDUND
312 if (gd->env_addr != (ulong)&(flash_addr->data)) {
313 env_t *etmp = flash_addr;
314 ulong ltmp = end_addr;
316 flash_addr = flash_addr_new;
317 flash_addr_new = etmp;
319 end_addr = end_addr_new;
323 if (flash_addr_new->flags != ENV_REDUND_OBSOLETE &&
324 crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc) {
325 char flag = ENV_REDUND_OBSOLETE;
327 gd->env_valid = ENV_REDUND;
328 flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new);
330 (ulong)&(flash_addr_new->flags),
331 sizeof(flash_addr_new->flags));
332 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
335 if (flash_addr->flags != ENV_REDUND_ACTIVE &&
336 (flash_addr->flags & ENV_REDUND_ACTIVE) == ENV_REDUND_ACTIVE) {
337 char flag = ENV_REDUND_ACTIVE;
339 gd->env_valid = ENV_REDUND;
340 flash_sect_protect(0, (ulong)flash_addr, end_addr);
342 (ulong)&(flash_addr->flags),
343 sizeof(flash_addr->flags));
344 flash_sect_protect(1, (ulong)flash_addr, end_addr);
347 if (gd->env_valid == ENV_REDUND)
348 puts("*** Warning - some problems detected "
349 "reading environment; recovered successfully\n\n");
350 #endif /* CONFIG_ENV_ADDR_REDUND */
352 return env_import((char *)flash_addr, 1);
356 U_BOOT_ENV_LOCATION(flash) = {
357 .location = ENVL_FLASH,
360 .load = env_flash_load,
363 .save = env_save_ptr(env_flash_save),
366 .init = env_flash_init,