[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 <flash.h>
#include <malloc.h>
#include <spi.h>
#include <spi_flash.h>
#include <search.h>
#include <errno.h>
#include <uuid.h>
#include <asm/cache.h>
#include <asm/global_data.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)
{
#if CONFIG_IS_ENABLED(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)
		spi_flash_free(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, H_EXTERNAL);

	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, H_EXTERNAL);
	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)
/*
 * check if Environment on CONFIG_ENV_ADDR is valid.
 */
static int env_sf_init_addr(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

#if defined(CONFIG_ENV_SPI_EARLY)
/*
 * early load environment from SPI flash (before relocation)
 * and check if it is valid.
 */
static int env_sf_init_early(void)
{
	int ret;
	int read1_fail;
	int read2_fail;
	int crc1_ok;
	env_t *tmp_env2 = NULL;
	env_t *tmp_env1;

	/*
	 * if malloc is not ready yet, we cannot use
	 * this part yet.
	 */
	if (!gd->malloc_limit)
		return -ENOENT;

	tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
			CONFIG_ENV_SIZE);
	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
		tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
					     CONFIG_ENV_SIZE);

	if (!tmp_env1 || !tmp_env2)
		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);

	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
		read2_fail = spi_flash_read(env_flash,
					    CONFIG_ENV_OFFSET_REDUND,
					    CONFIG_ENV_SIZE, tmp_env2);
		ret = env_check_redund((char *)tmp_env1, read1_fail,
				       (char *)tmp_env2, read2_fail);

		if (ret == -EIO || ret == -ENOMSG)
			goto err_read;

		if (gd->env_valid == ENV_VALID)
			gd->env_addr = (unsigned long)&tmp_env1->data;
		else
			gd->env_addr = (unsigned long)&tmp_env2->data;
	} else {
		if (read1_fail)
			goto err_read;

		crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
				tmp_env1->crc;
		if (!crc1_ok)
			goto err_read;

		/* if valid -> this is our env */
		gd->env_valid = ENV_VALID;
		gd->env_addr = (unsigned long)&tmp_env1->data;
	}

	return 0;
err_read:
	spi_flash_free(env_flash);
	env_flash = NULL;
	free(tmp_env1);
	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
		free(tmp_env2);
out:
	/* env is not valid. always return 0 */
	gd->env_valid = ENV_INVALID;
	return 0;
}
#endif

static int env_sf_init(void)
{
#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
	return env_sf_init_addr();
#elif defined(CONFIG_ENV_SPI_EARLY)
	return env_sf_init_early();
#endif
	/*
	 * return here -ENOENT, so env_init()
	 * can set the init bit and later if no
	 * other Environment storage is defined
	 * can set the default environment
	 */
	return -ENOENT;
}

U_BOOT_ENV_LOCATION(sf) = {
	.location	= ENVL_SPI_FLASH,
	ENV_NAME("SPIFlash")
	.load		= env_sf_load,
	.save		= CONFIG_IS_ENABLED(SAVEENV) ? ENV_SAVE_PTR(env_sf_save) : NULL,
	.init		= env_sf_init,
};
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>
b79fdc76	15	#include <flash.h>
5b3375ac	16	#include <malloc.h>
843c9e87	17	#include <spi.h>
8c66497e	18	#include <spi_flash.h>
ea882baf WD	19	#include <search.h>
ea882baf WD	20	#include <errno.h>
b79fdc76	21	#include <uuid.h>
90526e9f	22	#include <asm/cache.h>
401d1c4f	23	#include <asm/global_data.h>
19c31285	24	#include <dm/device-internal.h>
3db71108	25	#include <u-boot/crc.h>
8c66497e	26
4415f1d1	27	#ifndef CONFIG_SPL_BUILD
b500c92b	28	#define INITENV
4415f1d1 SG	29	#endif
4415f1d1 SG	30
7319bcaf	31	#ifdef CONFIG_ENV_OFFSET_REDUND
eb58a7fc IG	32	static ulong env_offset = CONFIG_ENV_OFFSET;
eb58a7fc IG	33	static ulong env_new_offset = CONFIG_ENV_OFFSET_REDUND;
a3110f01	34	#endif /* CONFIG_ENV_OFFSET_REDUND */
7319bcaf	35
8c66497e HS	36	DECLARE_GLOBAL_DATA_PTR;
8c66497e HS	37
8c66497e HS	38	static struct spi_flash *env_flash;
8c66497e HS	39
afa81a77	40	static int setup_flash_device(void)
7319bcaf	41	{
56c40460	42	#if CONFIG_IS_ENABLED(DM_SPI_FLASH)
19c31285	43	struct udevice *new;
afa81a77	44	int ret;
19c31285	45
96907c0f	46	/* speed and mode will be read from DT */
19c31285	47	ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
25a17652 KP	48	CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
25a17652 KP	49	&new);
19c31285	50	if (ret) {
0ac7d722	51	env_set_default("spi_flash_probe_bus_cs() failed", 0);
c5951991	52	return ret;
19c31285 GQ	53	}
	54
	55	env_flash = dev_get_uclass_priv(new);
	56	#else
c8cbf170 JT	57	if (env_flash)
c8cbf170 JT	58	spi_flash_free(env_flash);
7319bcaf	59
c8cbf170 JT	60	env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
c8cbf170 JT	61	CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
7319bcaf	62	if (!env_flash) {
c8cbf170 JT	63	env_set_default("spi_flash_probe() failed", 0);
c8cbf170 JT	64	return -EIO;
7319bcaf	65	}
19c31285	66	#endif
afa81a77 AF	67	return 0;
	68	}
	69
	70	#if defined(CONFIG_ENV_OFFSET_REDUND)
e5bce247	71	static int env_sf_save(void)
afa81a77 AF	72	{
afa81a77 AF	73	env_t env_new;
d3716dd6	74	char *saved_buffer = NULL, flag = ENV_REDUND_OBSOLETE;
0b2e5bbe	75	u32 saved_size, saved_offset, sector;
afa81a77 AF	76	int ret;
	77
	78	ret = setup_flash_device();
	79	if (ret)
	80	return ret;
7319bcaf	81
7ce1526e MV	82	ret = env_export(&env_new);
7ce1526e MV	83	if (ret)
c5951991	84	return -EIO;
d3716dd6	85	env_new.flags = ENV_REDUND_ACTIVE;
ea882baf	86
203e94f6	87	if (gd->env_valid == ENV_VALID) {
a3110f01 SB	88	env_new_offset = CONFIG_ENV_OFFSET_REDUND;
	89	env_offset = CONFIG_ENV_OFFSET;
	90	} else {
	91	env_new_offset = CONFIG_ENV_OFFSET;
	92	env_offset = CONFIG_ENV_OFFSET_REDUND;
	93	}
	94
7319bcaf WW	95	/* Is the sector larger than the env (i.e. embedded) */
	96	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
	97	saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
	98	saved_offset = env_new_offset + CONFIG_ENV_SIZE;
7dd01744	99	saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
7319bcaf	100	if (!saved_buffer) {
c5951991	101	ret = -ENOMEM;
7319bcaf WW	102	goto done;
7319bcaf WW	103	}
9ba5e5bc HS	104	ret = spi_flash_read(env_flash, saved_offset,
9ba5e5bc HS	105	saved_size, saved_buffer);
7319bcaf WW	106	if (ret)
	107	goto done;
	108	}
	109
0b2e5bbe	110	sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
7319bcaf WW	111
	112	puts("Erasing SPI flash...");
	113	ret = spi_flash_erase(env_flash, env_new_offset,
	114	sector * CONFIG_ENV_SECT_SIZE);
	115	if (ret)
	116	goto done;
	117
	118	puts("Writing to SPI flash...");
7319bcaf	119
a3110f01	120	ret = spi_flash_write(env_flash, env_new_offset,
cd0f4fa1	121	CONFIG_ENV_SIZE, &env_new);
7319bcaf WW	122	if (ret)
	123	goto done;
	124
	125	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
	126	ret = spi_flash_write(env_flash, saved_offset,
	127	saved_size, saved_buffer);
	128	if (ret)
	129	goto done;
	130	}
	131
eb58a7fc	132	ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
cd0f4fa1	133	sizeof(env_new.flags), &flag);
a3110f01 SB	134	if (ret)
a3110f01 SB	135	goto done;
7319bcaf	136
7319bcaf WW	137	puts("done\n");
7319bcaf WW	138
203e94f6	139	gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
a3110f01	140
2dc55d9e	141	printf("Valid environment: %d\n", (int)gd->env_valid);
a3110f01	142
ea5641ec	143	done:
7319bcaf WW	144	if (saved_buffer)
7319bcaf WW	145	free(saved_buffer);
eb58a7fc	146
7319bcaf WW	147	return ret;
	148	}
	149
c5951991	150	static int env_sf_load(void)
7319bcaf WW	151	{
7319bcaf WW	152	int ret;
80719938 SG	153	int read1_fail, read2_fail;
80719938 SG	154	env_t tmp_env1, tmp_env2;
7319bcaf	155
7dd01744 RB	156	tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
	157	CONFIG_ENV_SIZE);
	158	tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
	159	CONFIG_ENV_SIZE);
ea882baf	160	if (!tmp_env1 \|\| !tmp_env2) {
0ac7d722	161	env_set_default("malloc() failed", 0);
c5951991	162	ret = -EIO;
2dc55d9e	163	goto out;
7319bcaf WW	164	}
7319bcaf WW	165
8fee8845 AF	166	ret = setup_flash_device();
8fee8845 AF	167	if (ret)
2dc55d9e	168	goto out;
7319bcaf	169
9ba5e5bc HS	170	read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
	171	CONFIG_ENV_SIZE, tmp_env1);
	172	read2_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
	173	CONFIG_ENV_SIZE, tmp_env2);
ea882baf	174
80719938	175	ret = env_import_redund((char )tmp_env1, read1_fail, (char )tmp_env2,
890feeca	176	read2_fail, H_EXTERNAL);
7319bcaf	177
7319bcaf WW	178	spi_flash_free(env_flash);
7319bcaf WW	179	env_flash = NULL;
7319bcaf	180	out:
ea882baf WD	181	free(tmp_env1);
ea882baf WD	182	free(tmp_env2);
c5951991 SG	183
c5951991 SG	184	return ret;
7319bcaf WW	185	}
7319bcaf WW	186	#else
e5bce247	187	static int env_sf_save(void)
8c66497e	188	{
0b2e5bbe	189	u32 saved_size, saved_offset, sector;
7ce1526e	190	char *saved_buffer = NULL;
eb58a7fc	191	int ret = 1;
cd0f4fa1	192	env_t env_new;
19c31285	193
afa81a77 AF	194	ret = setup_flash_device();
	195	if (ret)
	196	return ret;
8c66497e	197
5b3375ac MF	198	/* Is the sector larger than the env (i.e. embedded) */
	199	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
	200	saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
	201	saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
	202	saved_buffer = malloc(saved_size);
eb58a7fc	203	if (!saved_buffer)
5b3375ac	204	goto done;
eb58a7fc	205
9ba5e5bc HS	206	ret = spi_flash_read(env_flash, saved_offset,
9ba5e5bc HS	207	saved_size, saved_buffer);
5b3375ac MF	208	if (ret)
	209	goto done;
	210	}
	211
7ce1526e MV	212	ret = env_export(&env_new);
7ce1526e MV	213	if (ret)
a3110f01	214	goto done;
a3110f01	215
0b2e5bbe AF	216	sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
0b2e5bbe AF	217
8c66497e	218	puts("Erasing SPI flash...");
a3110f01 SB	219	ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
a3110f01 SB	220	sector * CONFIG_ENV_SECT_SIZE);
5b3375ac MF	221	if (ret)
5b3375ac MF	222	goto done;
8c66497e HS	223
8c66497e HS	224	puts("Writing to SPI flash...");
a3110f01	225	ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
cd0f4fa1	226	CONFIG_ENV_SIZE, &env_new);
5b3375ac MF	227	if (ret)
5b3375ac MF	228	goto done;
8c66497e	229
5b3375ac	230	if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
a3110f01 SB	231	ret = spi_flash_write(env_flash, saved_offset,
a3110f01 SB	232	saved_size, saved_buffer);
5b3375ac MF	233	if (ret)
	234	goto done;
	235	}
	236
	237	ret = 0;
8c66497e	238	puts("done\n");
5b3375ac	239
ea5641ec	240	done:
5b3375ac MF	241	if (saved_buffer)
5b3375ac MF	242	free(saved_buffer);
eb58a7fc	243
5b3375ac	244	return ret;
8c66497e HS	245	}
8c66497e HS	246
c5951991	247	static int env_sf_load(void)
8c66497e HS	248	{
8c66497e HS	249	int ret;
5a89fa92	250	char *buf = NULL;
8c66497e	251
7dd01744	252	buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
c041c60c	253	if (!buf) {
0ac7d722	254	env_set_default("malloc() failed", 0);
c5951991	255	return -EIO;
ea882baf	256	}
8c66497e	257
c041c60c AF	258	ret = setup_flash_device();
	259	if (ret)
	260	goto out;
	261
9ba5e5bc HS	262	ret = spi_flash_read(env_flash,
9ba5e5bc HS	263	CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
ea882baf	264	if (ret) {
0ac7d722	265	env_set_default("spi_flash_read() failed", 0);
c041c60c	266	goto err_read;
ea882baf	267	}
8c66497e	268
890feeca	269	ret = env_import(buf, 1, H_EXTERNAL);
42a1820b	270	if (!ret)
203e94f6	271	gd->env_valid = ENV_VALID;
c041c60c AF	272
c041c60c AF	273	err_read:
8c66497e HS	274	spi_flash_free(env_flash);
8c66497e HS	275	env_flash = NULL;
c041c60c AF	276	out:
c041c60c AF	277	free(buf);
c5951991 SG	278
c5951991 SG	279	return ret;
8c66497e	280	}
7319bcaf	281	#endif
8c66497e	282
a09fea1d	283	#if CONFIG_ENV_ADDR != 0x0
119c01c2 RB	284	__weak void *env_sf_get_env_addr(void)
	285	{
	286	return (void *)CONFIG_ENV_ADDR;
	287	}
	288	#endif
	289
a09fea1d	290	#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
92765f45 HS	291	/*
	292	* check if Environment on CONFIG_ENV_ADDR is valid.
	293	*/
	294	static int env_sf_init_addr(void)
b500c92b	295	{
119c01c2	296	env_t env_ptr = (env_t )env_sf_get_env_addr();
b500c92b AK	297
	298	if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
	299	gd->env_addr = (ulong)&(env_ptr->data);
	300	gd->env_valid = 1;
	301	} else {
	302	gd->env_addr = (ulong)&default_environment[0];
	303	gd->env_valid = 1;
	304	}
	305
	306	return 0;
	307	}
	308	#endif
	309
92765f45 HS	310	#if defined(CONFIG_ENV_SPI_EARLY)
	311	/*
	312	* early load environment from SPI flash (before relocation)
	313	* and check if it is valid.
	314	*/
	315	static int env_sf_init_early(void)
	316	{
	317	int ret;
	318	int read1_fail;
	319	int read2_fail;
	320	int crc1_ok;
	321	env_t *tmp_env2 = NULL;
	322	env_t *tmp_env1;
	323
	324	/*
	325	* if malloc is not ready yet, we cannot use
	326	* this part yet.
	327	*/
	328	if (!gd->malloc_limit)
	329	return -ENOENT;
	330
	331	tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
	332	CONFIG_ENV_SIZE);
	333	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
	334	tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
	335	CONFIG_ENV_SIZE);
	336
	337	if (!tmp_env1 \|\| !tmp_env2)
	338	goto out;
	339
	340	ret = setup_flash_device();
	341	if (ret)
	342	goto out;
	343
	344	read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
	345	CONFIG_ENV_SIZE, tmp_env1);
	346
	347	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
	348	read2_fail = spi_flash_read(env_flash,
	349	CONFIG_ENV_OFFSET_REDUND,
	350	CONFIG_ENV_SIZE, tmp_env2);
	351	ret = env_check_redund((char *)tmp_env1, read1_fail,
	352	(char *)tmp_env2, read2_fail);
	353
	354	if (ret == -EIO \|\| ret == -ENOMSG)
	355	goto err_read;
	356
	357	if (gd->env_valid == ENV_VALID)
	358	gd->env_addr = (unsigned long)&tmp_env1->data;
	359	else
	360	gd->env_addr = (unsigned long)&tmp_env2->data;
	361	} else {
	362	if (read1_fail)
	363	goto err_read;
	364
	365	crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
	366	tmp_env1->crc;
	367	if (!crc1_ok)
	368	goto err_read;
	369
	370	/* if valid -> this is our env */
	371	gd->env_valid = ENV_VALID;
	372	gd->env_addr = (unsigned long)&tmp_env1->data;
	373	}
374
375	return 0;
376	err_read:
377	spi_flash_free(env_flash);
378	env_flash = NULL;
379	free(tmp_env1);
380	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
381	free(tmp_env2);
382	out:
383	/* env is not valid. always return 0 */
384	gd->env_valid = ENV_INVALID;
385	return 0;
386	}
387	#endif
388
389	static int env_sf_init(void)
390	{
391	#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
392	return env_sf_init_addr();
393	#elif defined(CONFIG_ENV_SPI_EARLY)
394	return env_sf_init_early();
395	#endif
396	/*
46ce9e77 HS	397	* return here -ENOENT, so env_init()
	398	* can set the init bit and later if no
	399	* other Environment storage is defined
	400	* can set the default environment
92765f45	401	*/
46ce9e77	402	return -ENOENT;
92765f45 HS	403	}
92765f45 HS	404
4415f1d1 SG	405	U_BOOT_ENV_LOCATION(sf) = {
4415f1d1 SG	406	.location = ENVL_SPI_FLASH,
22140d16	407	ENV_NAME("SPIFlash")
e5bce247	408	.load = env_sf_load,
6d3524c2	409	.save = CONFIG_IS_ENABLED(SAVEENV) ? ENV_SAVE_PTR(env_sf_save) : NULL,
b500c92b	410	.init = env_sf_init,
4415f1d1	411	};