]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/env_sf.c
doc: bootdelay: drop explanation about CONFIG_BOOTDELAY from README
[people/ms/u-boot.git] / common / env_sf.c
CommitLineData
8c66497e 1/*
ea882baf 2 * (C) Copyright 2000-2010
8c66497e
HS
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 *
8 * (C) Copyright 2008 Atmel Corporation
9 *
402ba1e3 10 * SPDX-License-Identifier: GPL-2.0+
8c66497e
HS
11 */
12#include <common.h>
8c66497e 13#include <environment.h>
5b3375ac 14#include <malloc.h>
843c9e87 15#include <spi.h>
8c66497e 16#include <spi_flash.h>
ea882baf
WD
17#include <search.h>
18#include <errno.h>
19c31285 19#include <dm/device-internal.h>
8c66497e 20
0e8d1586
JCPV
21#ifndef CONFIG_ENV_SPI_BUS
22# define CONFIG_ENV_SPI_BUS 0
8c66497e 23#endif
0e8d1586 24#ifndef CONFIG_ENV_SPI_CS
eb58a7fc 25# define CONFIG_ENV_SPI_CS 0
8c66497e 26#endif
0e8d1586
JCPV
27#ifndef CONFIG_ENV_SPI_MAX_HZ
28# define CONFIG_ENV_SPI_MAX_HZ 1000000
8c66497e 29#endif
0e8d1586
JCPV
30#ifndef CONFIG_ENV_SPI_MODE
31# define CONFIG_ENV_SPI_MODE SPI_MODE_3
8c66497e
HS
32#endif
33
7319bcaf 34#ifdef CONFIG_ENV_OFFSET_REDUND
eb58a7fc
IG
35static ulong env_offset = CONFIG_ENV_OFFSET;
36static ulong env_new_offset = CONFIG_ENV_OFFSET_REDUND;
7319bcaf 37
eb58a7fc
IG
38#define ACTIVE_FLAG 1
39#define OBSOLETE_FLAG 0
a3110f01 40#endif /* CONFIG_ENV_OFFSET_REDUND */
7319bcaf 41
8c66497e
HS
42DECLARE_GLOBAL_DATA_PTR;
43
eb58a7fc 44char *env_name_spec = "SPI Flash";
8c66497e
HS
45
46static struct spi_flash *env_flash;
47
7319bcaf 48#if defined(CONFIG_ENV_OFFSET_REDUND)
7319bcaf
WW
49int saveenv(void)
50{
cd0f4fa1 51 env_t env_new;
7ce1526e 52 char *saved_buffer = NULL, flag = OBSOLETE_FLAG;
eb58a7fc 53 u32 saved_size, saved_offset, sector = 1;
ea882baf 54 int ret;
19c31285
GQ
55#ifdef CONFIG_DM_SPI_FLASH
56 struct udevice *new;
57
58 ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
59 CONFIG_ENV_SPI_MAX_HZ,
60 CONFIG_ENV_SPI_MODE, &new);
61 if (ret) {
62 set_default_env("!spi_flash_probe_bus_cs() failed");
63 return 1;
64 }
65
66 env_flash = dev_get_uclass_priv(new);
67#else
7319bcaf
WW
68
69 if (!env_flash) {
a3110f01
SB
70 env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
71 CONFIG_ENV_SPI_CS,
72 CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
73 if (!env_flash) {
74 set_default_env("!spi_flash_probe() failed");
75 return 1;
76 }
7319bcaf 77 }
19c31285 78#endif
7319bcaf 79
7ce1526e
MV
80 ret = env_export(&env_new);
81 if (ret)
82 return ret;
cd0f4fa1 83 env_new.flags = ACTIVE_FLAG;
ea882baf 84
a3110f01
SB
85 if (gd->env_valid == 1) {
86 env_new_offset = CONFIG_ENV_OFFSET_REDUND;
87 env_offset = CONFIG_ENV_OFFSET;
88 } else {
89 env_new_offset = CONFIG_ENV_OFFSET;
90 env_offset = CONFIG_ENV_OFFSET_REDUND;
91 }
92
7319bcaf
WW
93 /* Is the sector larger than the env (i.e. embedded) */
94 if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
95 saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
96 saved_offset = env_new_offset + CONFIG_ENV_SIZE;
7dd01744 97 saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
7319bcaf
WW
98 if (!saved_buffer) {
99 ret = 1;
100 goto done;
101 }
102 ret = spi_flash_read(env_flash, saved_offset,
103 saved_size, saved_buffer);
104 if (ret)
105 goto done;
106 }
107
108 if (CONFIG_ENV_SIZE > CONFIG_ENV_SECT_SIZE) {
109 sector = CONFIG_ENV_SIZE / CONFIG_ENV_SECT_SIZE;
110 if (CONFIG_ENV_SIZE % CONFIG_ENV_SECT_SIZE)
111 sector++;
112 }
113
114 puts("Erasing SPI flash...");
115 ret = spi_flash_erase(env_flash, env_new_offset,
116 sector * CONFIG_ENV_SECT_SIZE);
117 if (ret)
118 goto done;
119
120 puts("Writing to SPI flash...");
7319bcaf 121
a3110f01 122 ret = spi_flash_write(env_flash, env_new_offset,
cd0f4fa1 123 CONFIG_ENV_SIZE, &env_new);
7319bcaf
WW
124 if (ret)
125 goto done;
126
127 if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
128 ret = spi_flash_write(env_flash, saved_offset,
129 saved_size, saved_buffer);
130 if (ret)
131 goto done;
132 }
133
eb58a7fc 134 ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
cd0f4fa1 135 sizeof(env_new.flags), &flag);
a3110f01
SB
136 if (ret)
137 goto done;
7319bcaf 138
7319bcaf
WW
139 puts("done\n");
140
eb58a7fc 141 gd->env_valid = gd->env_valid == 2 ? 1 : 2;
a3110f01 142
2dc55d9e 143 printf("Valid environment: %d\n", (int)gd->env_valid);
a3110f01 144
7319bcaf
WW
145 done:
146 if (saved_buffer)
147 free(saved_buffer);
eb58a7fc 148
7319bcaf
WW
149 return ret;
150}
151
152void env_relocate_spec(void)
153{
154 int ret;
155 int crc1_ok = 0, crc2_ok = 0;
156 env_t *tmp_env1 = NULL;
157 env_t *tmp_env2 = NULL;
a3110f01 158 env_t *ep = NULL;
7319bcaf 159
7dd01744
RB
160 tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
161 CONFIG_ENV_SIZE);
162 tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
163 CONFIG_ENV_SIZE);
ea882baf 164 if (!tmp_env1 || !tmp_env2) {
ea882baf 165 set_default_env("!malloc() failed");
2dc55d9e 166 goto out;
7319bcaf
WW
167 }
168
169 env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
170 CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
ea882baf
WD
171 if (!env_flash) {
172 set_default_env("!spi_flash_probe() failed");
2dc55d9e 173 goto out;
ea882baf 174 }
7319bcaf
WW
175
176 ret = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
177 CONFIG_ENV_SIZE, tmp_env1);
ea882baf
WD
178 if (ret) {
179 set_default_env("!spi_flash_read() failed");
7319bcaf 180 goto err_read;
ea882baf 181 }
7319bcaf
WW
182
183 if (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc)
184 crc1_ok = 1;
7319bcaf
WW
185
186 ret = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
187 CONFIG_ENV_SIZE, tmp_env2);
188 if (!ret) {
189 if (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc)
190 crc2_ok = 1;
7319bcaf
WW
191 }
192
a3110f01 193 if (!crc1_ok && !crc2_ok) {
a3110f01 194 set_default_env("!bad CRC");
2dc55d9e 195 goto err_read;
a3110f01 196 } else if (crc1_ok && !crc2_ok) {
7319bcaf 197 gd->env_valid = 1;
7319bcaf 198 } else if (!crc1_ok && crc2_ok) {
2dc55d9e 199 gd->env_valid = 2;
200 } else if (tmp_env1->flags == ACTIVE_FLAG &&
201 tmp_env2->flags == OBSOLETE_FLAG) {
7319bcaf 202 gd->env_valid = 1;
2dc55d9e 203 } else if (tmp_env1->flags == OBSOLETE_FLAG &&
204 tmp_env2->flags == ACTIVE_FLAG) {
a3110f01 205 gd->env_valid = 2;
2dc55d9e 206 } else if (tmp_env1->flags == tmp_env2->flags) {
5e8397dd 207 gd->env_valid = 1;
2dc55d9e 208 } else if (tmp_env1->flags == 0xFF) {
5e8397dd
MS
209 gd->env_valid = 1;
210 } else if (tmp_env2->flags == 0xFF) {
7319bcaf 211 gd->env_valid = 2;
7319bcaf
WW
212 } else {
213 /*
214 * this differs from code in env_flash.c, but I think a sane
215 * default path is desirable.
216 */
5e8397dd 217 gd->env_valid = 1;
7319bcaf 218 }
ea882baf 219
a3110f01
SB
220 if (gd->env_valid == 1)
221 ep = tmp_env1;
222 else
223 ep = tmp_env2;
224
225 ret = env_import((char *)ep, 0);
226 if (!ret) {
227 error("Cannot import environment: errno = %d\n", errno);
9a5d993e 228 set_default_env("!env_import failed");
7319bcaf 229 }
7319bcaf
WW
230
231err_read:
232 spi_flash_free(env_flash);
233 env_flash = NULL;
7319bcaf 234out:
ea882baf
WD
235 free(tmp_env1);
236 free(tmp_env2);
7319bcaf
WW
237}
238#else
8c66497e
HS
239int saveenv(void)
240{
eb58a7fc 241 u32 saved_size, saved_offset, sector = 1;
7ce1526e 242 char *saved_buffer = NULL;
eb58a7fc 243 int ret = 1;
cd0f4fa1 244 env_t env_new;
19c31285
GQ
245#ifdef CONFIG_DM_SPI_FLASH
246 struct udevice *new;
247
248 ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
249 CONFIG_ENV_SPI_MAX_HZ,
250 CONFIG_ENV_SPI_MODE, &new);
251 if (ret) {
252 set_default_env("!spi_flash_probe_bus_cs() failed");
253 return 1;
254 }
255
256 env_flash = dev_get_uclass_priv(new);
257#else
07efc9e3 258
8c66497e 259 if (!env_flash) {
a3110f01
SB
260 env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
261 CONFIG_ENV_SPI_CS,
262 CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
263 if (!env_flash) {
264 set_default_env("!spi_flash_probe() failed");
265 return 1;
266 }
8c66497e 267 }
19c31285 268#endif
8c66497e 269
5b3375ac
MF
270 /* Is the sector larger than the env (i.e. embedded) */
271 if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
272 saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
273 saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
274 saved_buffer = malloc(saved_size);
eb58a7fc 275 if (!saved_buffer)
5b3375ac 276 goto done;
eb58a7fc 277
a3110f01
SB
278 ret = spi_flash_read(env_flash, saved_offset,
279 saved_size, saved_buffer);
5b3375ac
MF
280 if (ret)
281 goto done;
282 }
283
0e8d1586
JCPV
284 if (CONFIG_ENV_SIZE > CONFIG_ENV_SECT_SIZE) {
285 sector = CONFIG_ENV_SIZE / CONFIG_ENV_SECT_SIZE;
286 if (CONFIG_ENV_SIZE % CONFIG_ENV_SECT_SIZE)
07efc9e3
TL
287 sector++;
288 }
289
7ce1526e
MV
290 ret = env_export(&env_new);
291 if (ret)
a3110f01 292 goto done;
a3110f01 293
8c66497e 294 puts("Erasing SPI flash...");
a3110f01
SB
295 ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
296 sector * CONFIG_ENV_SECT_SIZE);
5b3375ac
MF
297 if (ret)
298 goto done;
8c66497e
HS
299
300 puts("Writing to SPI flash...");
a3110f01 301 ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
cd0f4fa1 302 CONFIG_ENV_SIZE, &env_new);
5b3375ac
MF
303 if (ret)
304 goto done;
8c66497e 305
5b3375ac 306 if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
a3110f01
SB
307 ret = spi_flash_write(env_flash, saved_offset,
308 saved_size, saved_buffer);
5b3375ac
MF
309 if (ret)
310 goto done;
311 }
312
313 ret = 0;
8c66497e 314 puts("done\n");
5b3375ac
MF
315
316 done:
317 if (saved_buffer)
318 free(saved_buffer);
eb58a7fc 319
5b3375ac 320 return ret;
8c66497e
HS
321}
322
323void env_relocate_spec(void)
324{
325 int ret;
5a89fa92 326 char *buf = NULL;
8c66497e 327
7dd01744 328 buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
0e8d1586
JCPV
329 env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
330 CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
ea882baf
WD
331 if (!env_flash) {
332 set_default_env("!spi_flash_probe() failed");
5a89fa92
YZ
333 if (buf)
334 free(buf);
ea882baf
WD
335 return;
336 }
8c66497e 337
ea882baf
WD
338 ret = spi_flash_read(env_flash,
339 CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
340 if (ret) {
341 set_default_env("!spi_flash_read() failed");
342 goto out;
343 }
8c66497e 344
ea882baf 345 ret = env_import(buf, 1);
ea882baf
WD
346 if (ret)
347 gd->env_valid = 1;
348out:
8c66497e 349 spi_flash_free(env_flash);
5a89fa92
YZ
350 if (buf)
351 free(buf);
8c66497e 352 env_flash = NULL;
8c66497e 353}
7319bcaf 354#endif
8c66497e
HS
355
356int env_init(void)
357{
358 /* SPI flash isn't usable before relocation */
359 gd->env_addr = (ulong)&default_environment[0];
360 gd->env_valid = 1;
361
362 return 0;
363}