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