[u-boot.git] / env / sf.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2000-2010
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 *
 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
 * Andreas Heppel <[email protected]>
 *
 * (C) Copyright 2008 Atmel Corporation
 */
#include <common.h>
#include <dm.h>
#include <env.h>
#include <env_internal.h>
#include <malloc.h>
#include <spi.h>
#include <spi_flash.h>
#include <search.h>
#include <errno.h>
#include <dm/device-internal.h>
#include <u-boot/crc.h>

#ifndef CONFIG_SPL_BUILD
#define INITENV
#endif

#ifdef CONFIG_ENV_OFFSET_REDUND
static ulong env_offset		= CONFIG_ENV_OFFSET;
static ulong env_new_offset	= CONFIG_ENV_OFFSET_REDUND;
#endif /* CONFIG_ENV_OFFSET_REDUND */

DECLARE_GLOBAL_DATA_PTR;

static struct spi_flash *env_flash;

static int setup_flash_device(void)
{
#ifdef CONFIG_DM_SPI_FLASH
	struct udevice *new;
	int	ret;

	/* speed and mode will be read from DT */
	ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
				     CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
				     &new);
	if (ret) {
		env_set_default("spi_flash_probe_bus_cs() failed", 0);
		return ret;
	}

	env_flash = dev_get_uclass_priv(new);
#else

	if (!env_flash) {
		env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
			CONFIG_ENV_SPI_CS,
			CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
		if (!env_flash) {
			env_set_default("spi_flash_probe() failed", 0);
			return -EIO;
		}
	}
#endif
	return 0;
}

#if defined(CONFIG_ENV_OFFSET_REDUND)
static int env_sf_save(void)
{
	env_t	env_new;
	char	*saved_buffer = NULL, flag = ENV_REDUND_OBSOLETE;
	u32	saved_size, saved_offset, sector;
	int	ret;

	ret = setup_flash_device();
	if (ret)
		return ret;

	ret = env_export(&env_new);
	if (ret)
		return -EIO;
	env_new.flags	= ENV_REDUND_ACTIVE;

	if (gd->env_valid == ENV_VALID) {
		env_new_offset = CONFIG_ENV_OFFSET_REDUND;
		env_offset = CONFIG_ENV_OFFSET;
	} else {
		env_new_offset = CONFIG_ENV_OFFSET;
		env_offset = CONFIG_ENV_OFFSET_REDUND;
	}

	/* Is the sector larger than the env (i.e. embedded) */
	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
		saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
		saved_offset = env_new_offset + CONFIG_ENV_SIZE;
		saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
		if (!saved_buffer) {
			ret = -ENOMEM;
			goto done;
		}
		ret = spi_flash_read(env_flash, saved_offset,
					saved_size, saved_buffer);
		if (ret)
			goto done;
	}

	sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);

	puts("Erasing SPI flash...");
	ret = spi_flash_erase(env_flash, env_new_offset,
				sector * CONFIG_ENV_SECT_SIZE);
	if (ret)
		goto done;

	puts("Writing to SPI flash...");

	ret = spi_flash_write(env_flash, env_new_offset,
		CONFIG_ENV_SIZE, &env_new);
	if (ret)
		goto done;

	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
		ret = spi_flash_write(env_flash, saved_offset,
					saved_size, saved_buffer);
		if (ret)
			goto done;
	}

	ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
				sizeof(env_new.flags), &flag);
	if (ret)
		goto done;

	puts("done\n");

	gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;

	printf("Valid environment: %d\n", (int)gd->env_valid);

 done:
	if (saved_buffer)
		free(saved_buffer);

	return ret;
}

static int env_sf_load(void)
{
	int ret;
	int read1_fail, read2_fail;
	env_t *tmp_env1, *tmp_env2;

	tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
			CONFIG_ENV_SIZE);
	tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
			CONFIG_ENV_SIZE);
	if (!tmp_env1 || !tmp_env2) {
		env_set_default("malloc() failed", 0);
		ret = -EIO;
		goto out;
	}

	ret = setup_flash_device();
	if (ret)
		goto out;

	read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
				    CONFIG_ENV_SIZE, tmp_env1);
	read2_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
				    CONFIG_ENV_SIZE, tmp_env2);

	ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
				read2_fail);

	spi_flash_free(env_flash);
	env_flash = NULL;
out:
	free(tmp_env1);
	free(tmp_env2);

	return ret;
}
#else
static int env_sf_save(void)
{
	u32	saved_size, saved_offset, sector;
	char	*saved_buffer = NULL;
	int	ret = 1;
	env_t	env_new;

	ret = setup_flash_device();
	if (ret)
		return ret;

	/* Is the sector larger than the env (i.e. embedded) */
	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
		saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
		saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
		saved_buffer = malloc(saved_size);
		if (!saved_buffer)
			goto done;

		ret = spi_flash_read(env_flash, saved_offset,
			saved_size, saved_buffer);
		if (ret)
			goto done;
	}

	ret = env_export(&env_new);
	if (ret)
		goto done;

	sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);

	puts("Erasing SPI flash...");
	ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
		sector * CONFIG_ENV_SECT_SIZE);
	if (ret)
		goto done;

	puts("Writing to SPI flash...");
	ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
		CONFIG_ENV_SIZE, &env_new);
	if (ret)
		goto done;

	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
		ret = spi_flash_write(env_flash, saved_offset,
			saved_size, saved_buffer);
		if (ret)
			goto done;
	}

	ret = 0;
	puts("done\n");

 done:
	if (saved_buffer)
		free(saved_buffer);

	return ret;
}

static int env_sf_load(void)
{
	int ret;
	char *buf = NULL;

	buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
	if (!buf) {
		env_set_default("malloc() failed", 0);
		return -EIO;
	}

	ret = setup_flash_device();
	if (ret)
		goto out;

	ret = spi_flash_read(env_flash,
		CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
	if (ret) {
		env_set_default("spi_flash_read() failed", 0);
		goto err_read;
	}

	ret = env_import(buf, 1);
	if (!ret)
		gd->env_valid = ENV_VALID;

err_read:
	spi_flash_free(env_flash);
	env_flash = NULL;
out:
	free(buf);

	return ret;
}
#endif

#if CONFIG_ENV_ADDR != 0x0
__weak void *env_sf_get_env_addr(void)
{
	return (void *)CONFIG_ENV_ADDR;
}
#endif

#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
static int env_sf_init(void)
{
	env_t *env_ptr = (env_t *)env_sf_get_env_addr();

	if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
		gd->env_addr	= (ulong)&(env_ptr->data);
		gd->env_valid	= 1;
	} else {
		gd->env_addr = (ulong)&default_environment[0];
		gd->env_valid = 1;
	}

	return 0;
}
#endif

U_BOOT_ENV_LOCATION(sf) = {
	.location	= ENVL_SPI_FLASH,
	ENV_NAME("SPI Flash")
	.load		= env_sf_load,
	.save		= ENV_SAVE_PTR(env_sf_save),
#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
	.init		= env_sf_init,
#endif
};
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
8c66497e	2	/*
ea882baf	3	* (C) Copyright 2000-2010
8c66497e HS	4	* Wolfgang Denk, DENX Software Engineering, [email protected].
	5	*
	6	* (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
	7	* Andreas Heppel <[email protected]>
	8	*
	9	* (C) Copyright 2008 Atmel Corporation
8c66497e HS	10	*/
8c66497e HS	11	#include <common.h>
9d922450	12	#include <dm.h>
0ac7d722	13	#include <env.h>
f3998fdc	14	#include <env_internal.h>
5b3375ac	15	#include <malloc.h>
843c9e87	16	#include <spi.h>
8c66497e	17	#include <spi_flash.h>
ea882baf WD	18	#include <search.h>
ea882baf WD	19	#include <errno.h>
19c31285	20	#include <dm/device-internal.h>
3db71108	21	#include <u-boot/crc.h>
8c66497e	22
4415f1d1	23	#ifndef CONFIG_SPL_BUILD
b500c92b	24	#define INITENV
4415f1d1 SG	25	#endif
4415f1d1 SG	26
7319bcaf	27	#ifdef CONFIG_ENV_OFFSET_REDUND
eb58a7fc IG	28	static ulong env_offset = CONFIG_ENV_OFFSET;
eb58a7fc IG	29	static ulong env_new_offset = CONFIG_ENV_OFFSET_REDUND;
a3110f01	30	#endif /* CONFIG_ENV_OFFSET_REDUND */
7319bcaf	31
8c66497e HS	32	DECLARE_GLOBAL_DATA_PTR;
8c66497e HS	33
8c66497e HS	34	static struct spi_flash *env_flash;
8c66497e HS	35
afa81a77	36	static int setup_flash_device(void)
7319bcaf	37	{
19c31285 GQ	38	#ifdef CONFIG_DM_SPI_FLASH
19c31285 GQ	39	struct udevice *new;
afa81a77	40	int ret;
19c31285	41
96907c0f	42	/* speed and mode will be read from DT */
19c31285	43	ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
25a17652 KP	44	CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
25a17652 KP	45	&new);
19c31285	46	if (ret) {
0ac7d722	47	env_set_default("spi_flash_probe_bus_cs() failed", 0);
c5951991	48	return ret;
19c31285 GQ	49	}
	50
	51	env_flash = dev_get_uclass_priv(new);
	52	#else
7319bcaf WW	53
7319bcaf WW	54	if (!env_flash) {
a3110f01 SB	55	env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
	56	CONFIG_ENV_SPI_CS,
	57	CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
	58	if (!env_flash) {
0ac7d722	59	env_set_default("spi_flash_probe() failed", 0);
c5951991	60	return -EIO;
a3110f01	61	}
7319bcaf	62	}
19c31285	63	#endif
afa81a77 AF	64	return 0;
	65	}
	66
	67	#if defined(CONFIG_ENV_OFFSET_REDUND)
e5bce247	68	static int env_sf_save(void)
afa81a77 AF	69	{
afa81a77 AF	70	env_t env_new;
d3716dd6	71	char *saved_buffer = NULL, flag = ENV_REDUND_OBSOLETE;
0b2e5bbe	72	u32 saved_size, saved_offset, sector;
afa81a77 AF	73	int ret;
	74
	75	ret = setup_flash_device();
	76	if (ret)
	77	return ret;
7319bcaf	78
7ce1526e MV	79	ret = env_export(&env_new);
7ce1526e MV	80	if (ret)
c5951991	81	return -EIO;
d3716dd6	82	env_new.flags = ENV_REDUND_ACTIVE;
ea882baf	83
203e94f6	84	if (gd->env_valid == ENV_VALID) {
a3110f01 SB	85	env_new_offset = CONFIG_ENV_OFFSET_REDUND;
	86	env_offset = CONFIG_ENV_OFFSET;
	87	} else {
	88	env_new_offset = CONFIG_ENV_OFFSET;
	89	env_offset = CONFIG_ENV_OFFSET_REDUND;
	90	}
	91
7319bcaf WW	92	/* Is the sector larger than the env (i.e. embedded) */
	93	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
	94	saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
	95	saved_offset = env_new_offset + CONFIG_ENV_SIZE;
7dd01744	96	saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
7319bcaf	97	if (!saved_buffer) {
c5951991	98	ret = -ENOMEM;
7319bcaf WW	99	goto done;
7319bcaf WW	100	}
9ba5e5bc HS	101	ret = spi_flash_read(env_flash, saved_offset,
9ba5e5bc HS	102	saved_size, saved_buffer);
7319bcaf WW	103	if (ret)
	104	goto done;
	105	}
	106
0b2e5bbe	107	sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
7319bcaf WW	108
	109	puts("Erasing SPI flash...");
	110	ret = spi_flash_erase(env_flash, env_new_offset,
	111	sector * CONFIG_ENV_SECT_SIZE);
	112	if (ret)
	113	goto done;
	114
	115	puts("Writing to SPI flash...");
7319bcaf	116
a3110f01	117	ret = spi_flash_write(env_flash, env_new_offset,
cd0f4fa1	118	CONFIG_ENV_SIZE, &env_new);
7319bcaf WW	119	if (ret)
	120	goto done;
	121
	122	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
	123	ret = spi_flash_write(env_flash, saved_offset,
	124	saved_size, saved_buffer);
	125	if (ret)
	126	goto done;
	127	}
	128
eb58a7fc	129	ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
cd0f4fa1	130	sizeof(env_new.flags), &flag);
a3110f01 SB	131	if (ret)
a3110f01 SB	132	goto done;
7319bcaf	133
7319bcaf WW	134	puts("done\n");
7319bcaf WW	135
203e94f6	136	gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
a3110f01	137
2dc55d9e	138	printf("Valid environment: %d\n", (int)gd->env_valid);
a3110f01	139
7319bcaf WW	140	done:
	141	if (saved_buffer)
	142	free(saved_buffer);
eb58a7fc	143
7319bcaf WW	144	return ret;
	145	}
	146
c5951991	147	static int env_sf_load(void)
7319bcaf WW	148	{
7319bcaf WW	149	int ret;
80719938 SG	150	int read1_fail, read2_fail;
80719938 SG	151	env_t tmp_env1, tmp_env2;
7319bcaf	152
7dd01744 RB	153	tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
	154	CONFIG_ENV_SIZE);
	155	tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
	156	CONFIG_ENV_SIZE);
ea882baf	157	if (!tmp_env1 \|\| !tmp_env2) {
0ac7d722	158	env_set_default("malloc() failed", 0);
c5951991	159	ret = -EIO;
2dc55d9e	160	goto out;
7319bcaf WW	161	}
7319bcaf WW	162
8fee8845 AF	163	ret = setup_flash_device();
8fee8845 AF	164	if (ret)
2dc55d9e	165	goto out;
7319bcaf	166
9ba5e5bc HS	167	read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
	168	CONFIG_ENV_SIZE, tmp_env1);
	169	read2_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
	170	CONFIG_ENV_SIZE, tmp_env2);
ea882baf	171
80719938 SG	172	ret = env_import_redund((char )tmp_env1, read1_fail, (char )tmp_env2,
80719938 SG	173	read2_fail);
7319bcaf	174
7319bcaf WW	175	spi_flash_free(env_flash);
7319bcaf WW	176	env_flash = NULL;
7319bcaf	177	out:
ea882baf WD	178	free(tmp_env1);
ea882baf WD	179	free(tmp_env2);
c5951991 SG	180
c5951991 SG	181	return ret;
7319bcaf WW	182	}
7319bcaf WW	183	#else
e5bce247	184	static int env_sf_save(void)
8c66497e	185	{
0b2e5bbe	186	u32 saved_size, saved_offset, sector;
7ce1526e	187	char *saved_buffer = NULL;
eb58a7fc	188	int ret = 1;
cd0f4fa1	189	env_t env_new;
19c31285	190
afa81a77 AF	191	ret = setup_flash_device();
	192	if (ret)
	193	return ret;
8c66497e	194
5b3375ac MF	195	/* Is the sector larger than the env (i.e. embedded) */
	196	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
	197	saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
	198	saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
	199	saved_buffer = malloc(saved_size);
eb58a7fc	200	if (!saved_buffer)
5b3375ac	201	goto done;
eb58a7fc	202
9ba5e5bc HS	203	ret = spi_flash_read(env_flash, saved_offset,
9ba5e5bc HS	204	saved_size, saved_buffer);
5b3375ac MF	205	if (ret)
	206	goto done;
	207	}
	208
7ce1526e MV	209	ret = env_export(&env_new);
7ce1526e MV	210	if (ret)
a3110f01	211	goto done;
a3110f01	212
0b2e5bbe AF	213	sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
0b2e5bbe AF	214
8c66497e	215	puts("Erasing SPI flash...");
a3110f01 SB	216	ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
a3110f01 SB	217	sector * CONFIG_ENV_SECT_SIZE);
5b3375ac MF	218	if (ret)
5b3375ac MF	219	goto done;
8c66497e HS	220
8c66497e HS	221	puts("Writing to SPI flash...");
a3110f01	222	ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
cd0f4fa1	223	CONFIG_ENV_SIZE, &env_new);
5b3375ac MF	224	if (ret)
5b3375ac MF	225	goto done;
8c66497e	226
5b3375ac	227	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
a3110f01 SB	228	ret = spi_flash_write(env_flash, saved_offset,
a3110f01 SB	229	saved_size, saved_buffer);
5b3375ac MF	230	if (ret)
	231	goto done;
	232	}
	233
	234	ret = 0;
8c66497e	235	puts("done\n");
5b3375ac MF	236
	237	done:
	238	if (saved_buffer)
	239	free(saved_buffer);
eb58a7fc	240
5b3375ac	241	return ret;
8c66497e HS	242	}
8c66497e HS	243
c5951991	244	static int env_sf_load(void)
8c66497e HS	245	{
8c66497e HS	246	int ret;
5a89fa92	247	char *buf = NULL;
8c66497e	248
7dd01744	249	buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
c041c60c	250	if (!buf) {
0ac7d722	251	env_set_default("malloc() failed", 0);
c5951991	252	return -EIO;
ea882baf	253	}
8c66497e	254
c041c60c AF	255	ret = setup_flash_device();
	256	if (ret)
	257	goto out;
	258
9ba5e5bc HS	259	ret = spi_flash_read(env_flash,
9ba5e5bc HS	260	CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
ea882baf	261	if (ret) {
0ac7d722	262	env_set_default("spi_flash_read() failed", 0);
c041c60c	263	goto err_read;
ea882baf	264	}
8c66497e	265
ea882baf	266	ret = env_import(buf, 1);
42a1820b	267	if (!ret)
203e94f6	268	gd->env_valid = ENV_VALID;
c041c60c AF	269
c041c60c AF	270	err_read:
8c66497e HS	271	spi_flash_free(env_flash);
8c66497e HS	272	env_flash = NULL;
c041c60c AF	273	out:
c041c60c AF	274	free(buf);
c5951991 SG	275
c5951991 SG	276	return ret;
8c66497e	277	}
7319bcaf	278	#endif
8c66497e	279
a09fea1d	280	#if CONFIG_ENV_ADDR != 0x0
119c01c2 RB	281	__weak void *env_sf_get_env_addr(void)
	282	{
	283	return (void *)CONFIG_ENV_ADDR;
	284	}
	285	#endif
	286
a09fea1d	287	#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
b500c92b AK	288	static int env_sf_init(void)
b500c92b AK	289	{
119c01c2	290	env_t env_ptr = (env_t )env_sf_get_env_addr();
b500c92b AK	291
	292	if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
	293	gd->env_addr = (ulong)&(env_ptr->data);
	294	gd->env_valid = 1;
	295	} else {
	296	gd->env_addr = (ulong)&default_environment[0];
	297	gd->env_valid = 1;
	298	}
	299
	300	return 0;
	301	}
	302	#endif
	303
4415f1d1 SG	304	U_BOOT_ENV_LOCATION(sf) = {
4415f1d1 SG	305	.location = ENVL_SPI_FLASH,
ac358beb	306	ENV_NAME("SPI Flash")
e5bce247	307	.load = env_sf_load,
9e3c94d1	308	.save = ENV_SAVE_PTR(env_sf_save),
a09fea1d	309	#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
b500c92b AK	310	.init = env_sf_init,
b500c92b AK	311	#endif
4415f1d1	312	};