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