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