[thirdparty/u-boot.git] / env / ubi.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (c) Copyright 2012 by National Instruments,
 *        Joe Hershberger <joe.hershberger@ni.com>
 */

#include <common.h>
#include <asm/global_data.h>

#include <command.h>
#include <env.h>
#include <env_internal.h>
#include <errno.h>
#include <malloc.h>
#include <memalign.h>
#include <search.h>
#include <ubi_uboot.h>
#undef crc32

#define _QUOTE(x) #x
#define QUOTE(x) _QUOTE(x)

#if (CONFIG_ENV_UBI_VID_OFFSET == 0)
 #define UBI_VID_OFFSET NULL
#else
 #define UBI_VID_OFFSET QUOTE(CONFIG_ENV_UBI_VID_OFFSET)
#endif

DECLARE_GLOBAL_DATA_PTR;

#if CONFIG_SYS_REDUNDAND_ENVIRONMENT
#define ENV_UBI_VOLUME_REDUND CONFIG_ENV_UBI_VOLUME_REDUND
#else
#define ENV_UBI_VOLUME_REDUND "invalid"
#endif

#ifdef CONFIG_CMD_SAVEENV
#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
static int env_ubi_save(void)
{
	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
	int ret;

	ret = env_export(env_new);
	if (ret)
		return ret;

	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
		printf("\n** Cannot find mtd partition \"%s\"\n",
		       CONFIG_ENV_UBI_PART);
		return 1;
	}

	if (gd->env_valid == ENV_VALID) {
		puts("Writing to redundant UBI... ");
		if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME_REDUND,
				     (void *)env_new, CONFIG_ENV_SIZE)) {
			printf("\n** Unable to write env to %s:%s **\n",
			       CONFIG_ENV_UBI_PART,
			       CONFIG_ENV_UBI_VOLUME_REDUND);
			return 1;
		}
	} else {
		puts("Writing to UBI... ");
		if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME,
				     (void *)env_new, CONFIG_ENV_SIZE)) {
			printf("\n** Unable to write env to %s:%s **\n",
			       CONFIG_ENV_UBI_PART,
			       CONFIG_ENV_UBI_VOLUME);
			return 1;
		}
	}

	puts("done\n");

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

	return 0;
}
#else /* ! CONFIG_SYS_REDUNDAND_ENVIRONMENT */
static int env_ubi_save(void)
{
	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
	int ret;

	ret = env_export(env_new);
	if (ret)
		return ret;

	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
		printf("\n** Cannot find mtd partition \"%s\"\n",
		       CONFIG_ENV_UBI_PART);
		return 1;
	}

	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME, (void *)env_new,
			     CONFIG_ENV_SIZE)) {
		printf("\n** Unable to write env to %s:%s **\n",
		       CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
		return 1;
	}

	puts("done\n");
	return 0;
}
#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
#endif /* CONFIG_CMD_SAVEENV */

#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
static int env_ubi_load(void)
{
	ALLOC_CACHE_ALIGN_BUFFER(char, env1_buf, CONFIG_ENV_SIZE);
	ALLOC_CACHE_ALIGN_BUFFER(char, env2_buf, CONFIG_ENV_SIZE);
	int read1_fail, read2_fail;
	env_t *tmp_env1, *tmp_env2;

	/*
	 * In case we have restarted u-boot there is a chance that buffer
	 * contains old environment (from the previous boot).
	 * If UBI volume is zero size, ubi_volume_read() doesn't modify the
	 * buffer.
	 * We need to clear buffer manually here, so the invalid CRC will
	 * cause setting default environment as expected.
	 */
	memset(env1_buf, 0x0, CONFIG_ENV_SIZE);
	memset(env2_buf, 0x0, CONFIG_ENV_SIZE);

	tmp_env1 = (env_t *)env1_buf;
	tmp_env2 = (env_t *)env2_buf;

	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
		printf("\n** Cannot find mtd partition \"%s\"\n",
		       CONFIG_ENV_UBI_PART);
		env_set_default(NULL, 0);
		return -EIO;
	}

	read1_fail = ubi_volume_read(CONFIG_ENV_UBI_VOLUME, (void *)tmp_env1,
				     CONFIG_ENV_SIZE);
	if (read1_fail)
		printf("\n** Unable to read env from %s:%s **\n",
		       CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);

	read2_fail = ubi_volume_read(CONFIG_ENV_UBI_VOLUME_REDUND,
				     (void *)tmp_env2, CONFIG_ENV_SIZE);
	if (read2_fail)
		printf("\n** Unable to read redundant env from %s:%s **\n",
		       CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME_REDUND);

	return env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
				 read2_fail, H_EXTERNAL);
}
#else /* ! CONFIG_SYS_REDUNDAND_ENVIRONMENT */
static int env_ubi_load(void)
{
	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);

	/*
	 * In case we have restarted u-boot there is a chance that buffer
	 * contains old environment (from the previous boot).
	 * If UBI volume is zero size, ubi_volume_read() doesn't modify the
	 * buffer.
	 * We need to clear buffer manually here, so the invalid CRC will
	 * cause setting default environment as expected.
	 */
	memset(buf, 0x0, CONFIG_ENV_SIZE);

	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
		printf("\n** Cannot find mtd partition \"%s\"\n",
		       CONFIG_ENV_UBI_PART);
		env_set_default(NULL, 0);
		return -EIO;
	}

	if (ubi_volume_read(CONFIG_ENV_UBI_VOLUME, buf, CONFIG_ENV_SIZE)) {
		printf("\n** Unable to read env from %s:%s **\n",
		       CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
		env_set_default(NULL, 0);
		return -EIO;
	}

	return env_import(buf, 1, H_EXTERNAL);
}
#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */

static int env_ubi_erase(void)
{
	ALLOC_CACHE_ALIGN_BUFFER(char, env_buf, CONFIG_ENV_SIZE);
	int ret = 0;

	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
		printf("\n** Cannot find mtd partition \"%s\"\n",
		       CONFIG_ENV_UBI_PART);
		return 1;
	}

	memset(env_buf, 0x0, CONFIG_ENV_SIZE);

	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME,
			     (void *)env_buf, CONFIG_ENV_SIZE)) {
		printf("\n** Unable to erase env to %s:%s **\n",
		       CONFIG_ENV_UBI_PART,
		       CONFIG_ENV_UBI_VOLUME);
		ret = 1;
	}
	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
		if (ubi_volume_write(ENV_UBI_VOLUME_REDUND,
				     (void *)env_buf, CONFIG_ENV_SIZE)) {
			printf("\n** Unable to erase env to %s:%s **\n",
			       CONFIG_ENV_UBI_PART,
			       ENV_UBI_VOLUME_REDUND);
			ret = 1;
		}
	}

	return ret;
}

U_BOOT_ENV_LOCATION(ubi) = {
	.location	= ENVL_UBI,
	ENV_NAME("UBI")
	.load		= env_ubi_load,
	.save		= env_save_ptr(env_ubi_save),
	.erase		= ENV_ERASE_PTR(env_ubi_erase),
};
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
2b74433f JH	2	/*
	3	* (c) Copyright 2012 by National Instruments,
	4	* Joe Hershberger <joe.hershberger@ni.com>
2b74433f JH	5	*/
	6
	7	#include <common.h>
401d1c4f	8	#include <asm/global_data.h>
2b74433f JH	9
2b74433f JH	10	#include <command.h>
0ac7d722	11	#include <env.h>
f3998fdc	12	#include <env_internal.h>
2b74433f JH	13	#include <errno.h>
2b74433f JH	14	#include <malloc.h>
cf92e05c	15	#include <memalign.h>
2b74433f JH	16	#include <search.h>
	17	#include <ubi_uboot.h>
	18	#undef crc32
	19
985186d1 HG	20	#define _QUOTE(x) #x
	21	#define QUOTE(x) _QUOTE(x)
	22
	23	#if (CONFIG_ENV_UBI_VID_OFFSET == 0)
	24	#define UBI_VID_OFFSET NULL
	25	#else
	26	#define UBI_VID_OFFSET QUOTE(CONFIG_ENV_UBI_VID_OFFSET)
	27	#endif
	28
2b74433f JH	29	DECLARE_GLOBAL_DATA_PTR;
2b74433f JH	30
91fc7858 PD	31	#if CONFIG_SYS_REDUNDAND_ENVIRONMENT
	32	#define ENV_UBI_VOLUME_REDUND CONFIG_ENV_UBI_VOLUME_REDUND
	33	#else
	34	#define ENV_UBI_VOLUME_REDUND "invalid"
	35	#endif
	36
2b74433f	37	#ifdef CONFIG_CMD_SAVEENV
785881f7	38	#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
e5bce247	39	static int env_ubi_save(void)
785881f7 JH	40	{
785881f7 JH	41	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
7ce1526e	42	int ret;
785881f7	43
7ce1526e MV	44	ret = env_export(env_new);
	45	if (ret)
	46	return ret;
785881f7	47
985186d1	48	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
785881f7 JH	49	printf("\n** Cannot find mtd partition \"%s\"\n",
	50	CONFIG_ENV_UBI_PART);
	51	return 1;
	52	}
	53
203e94f6	54	if (gd->env_valid == ENV_VALID) {
785881f7 JH	55	puts("Writing to redundant UBI... ");
	56	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME_REDUND,
	57	(void *)env_new, CONFIG_ENV_SIZE)) {
	58	printf("\n Unable to write env to %s:%s \n",
	59	CONFIG_ENV_UBI_PART,
	60	CONFIG_ENV_UBI_VOLUME_REDUND);
	61	return 1;
	62	}
	63	} else {
	64	puts("Writing to UBI... ");
	65	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME,
	66	(void *)env_new, CONFIG_ENV_SIZE)) {
	67	printf("\n Unable to write env to %s:%s \n",
	68	CONFIG_ENV_UBI_PART,
	69	CONFIG_ENV_UBI_VOLUME);
	70	return 1;
	71	}
	72	}
	73
	74	puts("done\n");
	75
203e94f6	76	gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
785881f7 JH	77
	78	return 0;
	79	}
	80	#else /* ! CONFIG_SYS_REDUNDAND_ENVIRONMENT */
e5bce247	81	static int env_ubi_save(void)
2b74433f JH	82	{
2b74433f JH	83	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
7ce1526e	84	int ret;
2b74433f	85
7ce1526e MV	86	ret = env_export(env_new);
	87	if (ret)
	88	return ret;
2b74433f	89
985186d1	90	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
2b74433f JH	91	printf("\n** Cannot find mtd partition \"%s\"\n",
	92	CONFIG_ENV_UBI_PART);
	93	return 1;
	94	}
	95
2b74433f JH	96	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME, (void *)env_new,
	97	CONFIG_ENV_SIZE)) {
	98	printf("\n Unable to write env to %s:%s \n",
	99	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
	100	return 1;
	101	}
	102
	103	puts("done\n");
	104	return 0;
	105	}
785881f7	106	#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
2b74433f JH	107	#endif /* CONFIG_CMD_SAVEENV */
2b74433f JH	108
785881f7	109	#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
c5951991	110	static int env_ubi_load(void)
785881f7 JH	111	{
	112	ALLOC_CACHE_ALIGN_BUFFER(char, env1_buf, CONFIG_ENV_SIZE);
	113	ALLOC_CACHE_ALIGN_BUFFER(char, env2_buf, CONFIG_ENV_SIZE);
31f044bd	114	int read1_fail, read2_fail;
9d364af2	115	env_t tmp_env1, tmp_env2;
785881f7	116
c1f51e0f MN	117	/*
	118	* In case we have restarted u-boot there is a chance that buffer
	119	* contains old environment (from the previous boot).
	120	* If UBI volume is zero size, ubi_volume_read() doesn't modify the
	121	* buffer.
	122	* We need to clear buffer manually here, so the invalid CRC will
	123	* cause setting default environment as expected.
	124	*/
	125	memset(env1_buf, 0x0, CONFIG_ENV_SIZE);
	126	memset(env2_buf, 0x0, CONFIG_ENV_SIZE);
	127
785881f7 JH	128	tmp_env1 = (env_t *)env1_buf;
	129	tmp_env2 = (env_t *)env2_buf;
	130
985186d1	131	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
785881f7 JH	132	printf("\n** Cannot find mtd partition \"%s\"\n",
785881f7 JH	133	CONFIG_ENV_UBI_PART);
0ac7d722	134	env_set_default(NULL, 0);
c5951991	135	return -EIO;
785881f7 JH	136	}
785881f7 JH	137
31f044bd SG	138	read1_fail = ubi_volume_read(CONFIG_ENV_UBI_VOLUME, (void *)tmp_env1,
	139	CONFIG_ENV_SIZE);
	140	if (read1_fail)
785881f7 JH	141	printf("\n Unable to read env from %s:%s \n",
785881f7 JH	142	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
785881f7	143
31f044bd SG	144	read2_fail = ubi_volume_read(CONFIG_ENV_UBI_VOLUME_REDUND,
	145	(void *)tmp_env2, CONFIG_ENV_SIZE);
	146	if (read2_fail)
785881f7 JH	147	printf("\n Unable to read redundant env from %s:%s \n",
785881f7 JH	148	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME_REDUND);
785881f7	149
31f044bd	150	return env_import_redund((char )tmp_env1, read1_fail, (char )tmp_env2,
890feeca	151	read2_fail, H_EXTERNAL);
785881f7 JH	152	}
785881f7 JH	153	#else /* ! CONFIG_SYS_REDUNDAND_ENVIRONMENT */
c5951991	154	static int env_ubi_load(void)
2b74433f JH	155	{
	156	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
	157
c1f51e0f MN	158	/*
	159	* In case we have restarted u-boot there is a chance that buffer
	160	* contains old environment (from the previous boot).
	161	* If UBI volume is zero size, ubi_volume_read() doesn't modify the
	162	* buffer.
	163	* We need to clear buffer manually here, so the invalid CRC will
	164	* cause setting default environment as expected.
	165	*/
	166	memset(buf, 0x0, CONFIG_ENV_SIZE);
	167
985186d1	168	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
2b74433f JH	169	printf("\n** Cannot find mtd partition \"%s\"\n",
2b74433f JH	170	CONFIG_ENV_UBI_PART);
0ac7d722	171	env_set_default(NULL, 0);
c5951991	172	return -EIO;
2b74433f JH	173	}
2b74433f JH	174
a7c06cd3	175	if (ubi_volume_read(CONFIG_ENV_UBI_VOLUME, buf, CONFIG_ENV_SIZE)) {
2b74433f JH	176	printf("\n Unable to read env from %s:%s \n",
2b74433f JH	177	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
0ac7d722	178	env_set_default(NULL, 0);
c5951991	179	return -EIO;
2b74433f JH	180	}
2b74433f JH	181
890feeca	182	return env_import(buf, 1, H_EXTERNAL);
2b74433f	183	}
785881f7	184	#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
4415f1d1	185
91fc7858 PD	186	static int env_ubi_erase(void)
	187	{
	188	ALLOC_CACHE_ALIGN_BUFFER(char, env_buf, CONFIG_ENV_SIZE);
	189	int ret = 0;
	190
	191	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
	192	printf("\n** Cannot find mtd partition \"%s\"\n",
	193	CONFIG_ENV_UBI_PART);
	194	return 1;
	195	}
	196
	197	memset(env_buf, 0x0, CONFIG_ENV_SIZE);
	198
	199	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME,
	200	(void *)env_buf, CONFIG_ENV_SIZE)) {
	201	printf("\n Unable to erase env to %s:%s \n",
	202	CONFIG_ENV_UBI_PART,
	203	CONFIG_ENV_UBI_VOLUME);
	204	ret = 1;
	205	}
	206	if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
	207	if (ubi_volume_write(ENV_UBI_VOLUME_REDUND,
	208	(void *)env_buf, CONFIG_ENV_SIZE)) {
	209	printf("\n Unable to erase env to %s:%s \n",
	210	CONFIG_ENV_UBI_PART,
	211	ENV_UBI_VOLUME_REDUND);
	212	ret = 1;
	213	}
	214	}
	215
	216	return ret;
	217	}
	218
4415f1d1 SG	219	U_BOOT_ENV_LOCATION(ubi) = {
4415f1d1 SG	220	.location = ENVL_UBI,
344ca795	221	ENV_NAME("UBI")
e5bce247 SG	222	.load = env_ubi_load,
e5bce247 SG	223	.save = env_save_ptr(env_ubi_save),
91fc7858	224	.erase = ENV_ERASE_PTR(env_ubi_erase),
4415f1d1	225	};