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