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