[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 <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;

#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);
}
#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);
}
#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */

U_BOOT_ENV_LOCATION(ubi) = {
	.location	= ENVL_UBI,
	ENV_NAME("UBI")
	.load		= env_ubi_load,
	.save		= env_save_ptr(env_ubi_save),
};
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>
	8
	9	#include <command.h>
0ac7d722	10	#include <env.h>
f3998fdc	11	#include <env_internal.h>
2b74433f JH	12	#include <errno.h>
2b74433f JH	13	#include <malloc.h>
cf92e05c	14	#include <memalign.h>
2b74433f JH	15	#include <search.h>
	16	#include <ubi_uboot.h>
	17	#undef crc32
	18
985186d1 HG	19	#define _QUOTE(x) #x
	20	#define QUOTE(x) _QUOTE(x)
	21
	22	#if (CONFIG_ENV_UBI_VID_OFFSET == 0)
	23	#define UBI_VID_OFFSET NULL
	24	#else
	25	#define UBI_VID_OFFSET QUOTE(CONFIG_ENV_UBI_VID_OFFSET)
	26	#endif
	27
2b74433f JH	28	DECLARE_GLOBAL_DATA_PTR;
2b74433f JH	29
2b74433f	30	#ifdef CONFIG_CMD_SAVEENV
785881f7	31	#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
e5bce247	32	static int env_ubi_save(void)
785881f7 JH	33	{
785881f7 JH	34	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
7ce1526e	35	int ret;
785881f7	36
7ce1526e MV	37	ret = env_export(env_new);
	38	if (ret)
	39	return ret;
785881f7	40
985186d1	41	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
785881f7 JH	42	printf("\n** Cannot find mtd partition \"%s\"\n",
	43	CONFIG_ENV_UBI_PART);
	44	return 1;
	45	}
	46
203e94f6	47	if (gd->env_valid == ENV_VALID) {
785881f7 JH	48	puts("Writing to redundant UBI... ");
	49	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME_REDUND,
	50	(void *)env_new, CONFIG_ENV_SIZE)) {
	51	printf("\n Unable to write env to %s:%s \n",
	52	CONFIG_ENV_UBI_PART,
	53	CONFIG_ENV_UBI_VOLUME_REDUND);
	54	return 1;
	55	}
	56	} else {
	57	puts("Writing to UBI... ");
	58	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME,
	59	(void *)env_new, CONFIG_ENV_SIZE)) {
	60	printf("\n Unable to write env to %s:%s \n",
	61	CONFIG_ENV_UBI_PART,
	62	CONFIG_ENV_UBI_VOLUME);
	63	return 1;
	64	}
	65	}
	66
	67	puts("done\n");
	68
203e94f6	69	gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
785881f7 JH	70
	71	return 0;
	72	}
	73	#else /* ! CONFIG_SYS_REDUNDAND_ENVIRONMENT */
e5bce247	74	static int env_ubi_save(void)
2b74433f JH	75	{
2b74433f JH	76	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
7ce1526e	77	int ret;
2b74433f	78
7ce1526e MV	79	ret = env_export(env_new);
	80	if (ret)
	81	return ret;
2b74433f	82
985186d1	83	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
2b74433f JH	84	printf("\n** Cannot find mtd partition \"%s\"\n",
	85	CONFIG_ENV_UBI_PART);
	86	return 1;
	87	}
	88
2b74433f JH	89	if (ubi_volume_write(CONFIG_ENV_UBI_VOLUME, (void *)env_new,
	90	CONFIG_ENV_SIZE)) {
	91	printf("\n Unable to write env to %s:%s \n",
	92	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
	93	return 1;
	94	}
	95
	96	puts("done\n");
	97	return 0;
	98	}
785881f7	99	#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
2b74433f JH	100	#endif /* CONFIG_CMD_SAVEENV */
2b74433f JH	101
785881f7	102	#ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
c5951991	103	static int env_ubi_load(void)
785881f7 JH	104	{
	105	ALLOC_CACHE_ALIGN_BUFFER(char, env1_buf, CONFIG_ENV_SIZE);
	106	ALLOC_CACHE_ALIGN_BUFFER(char, env2_buf, CONFIG_ENV_SIZE);
31f044bd	107	int read1_fail, read2_fail;
9d364af2	108	env_t tmp_env1, tmp_env2;
785881f7	109
c1f51e0f MN	110	/*
	111	* In case we have restarted u-boot there is a chance that buffer
	112	* contains old environment (from the previous boot).
	113	* If UBI volume is zero size, ubi_volume_read() doesn't modify the
	114	* buffer.
	115	* We need to clear buffer manually here, so the invalid CRC will
	116	* cause setting default environment as expected.
	117	*/
	118	memset(env1_buf, 0x0, CONFIG_ENV_SIZE);
	119	memset(env2_buf, 0x0, CONFIG_ENV_SIZE);
	120
785881f7 JH	121	tmp_env1 = (env_t *)env1_buf;
	122	tmp_env2 = (env_t *)env2_buf;
	123
985186d1	124	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
785881f7 JH	125	printf("\n** Cannot find mtd partition \"%s\"\n",
785881f7 JH	126	CONFIG_ENV_UBI_PART);
0ac7d722	127	env_set_default(NULL, 0);
c5951991	128	return -EIO;
785881f7 JH	129	}
785881f7 JH	130
31f044bd SG	131	read1_fail = ubi_volume_read(CONFIG_ENV_UBI_VOLUME, (void *)tmp_env1,
	132	CONFIG_ENV_SIZE);
	133	if (read1_fail)
785881f7 JH	134	printf("\n Unable to read env from %s:%s \n",
785881f7 JH	135	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
785881f7	136
31f044bd SG	137	read2_fail = ubi_volume_read(CONFIG_ENV_UBI_VOLUME_REDUND,
	138	(void *)tmp_env2, CONFIG_ENV_SIZE);
	139	if (read2_fail)
785881f7 JH	140	printf("\n Unable to read redundant env from %s:%s \n",
785881f7 JH	141	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME_REDUND);
785881f7	142
31f044bd SG	143	return env_import_redund((char )tmp_env1, read1_fail, (char )tmp_env2,
31f044bd SG	144	read2_fail);
785881f7 JH	145	}
785881f7 JH	146	#else /* ! CONFIG_SYS_REDUNDAND_ENVIRONMENT */
c5951991	147	static int env_ubi_load(void)
2b74433f JH	148	{
	149	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
	150
c1f51e0f MN	151	/*
	152	* In case we have restarted u-boot there is a chance that buffer
	153	* contains old environment (from the previous boot).
	154	* If UBI volume is zero size, ubi_volume_read() doesn't modify the
	155	* buffer.
	156	* We need to clear buffer manually here, so the invalid CRC will
	157	* cause setting default environment as expected.
	158	*/
	159	memset(buf, 0x0, CONFIG_ENV_SIZE);
	160
985186d1	161	if (ubi_part(CONFIG_ENV_UBI_PART, UBI_VID_OFFSET)) {
2b74433f JH	162	printf("\n** Cannot find mtd partition \"%s\"\n",
2b74433f JH	163	CONFIG_ENV_UBI_PART);
0ac7d722	164	env_set_default(NULL, 0);
c5951991	165	return -EIO;
2b74433f JH	166	}
2b74433f JH	167
a7c06cd3	168	if (ubi_volume_read(CONFIG_ENV_UBI_VOLUME, buf, CONFIG_ENV_SIZE)) {
2b74433f JH	169	printf("\n Unable to read env from %s:%s \n",
2b74433f JH	170	CONFIG_ENV_UBI_PART, CONFIG_ENV_UBI_VOLUME);
0ac7d722	171	env_set_default(NULL, 0);
c5951991	172	return -EIO;
2b74433f JH	173	}
2b74433f JH	174
2166ebf7	175	return env_import(buf, 1);
2b74433f	176	}
785881f7	177	#endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
4415f1d1 SG	178
	179	U_BOOT_ENV_LOCATION(ubi) = {
	180	.location = ENVL_UBI,
344ca795	181	ENV_NAME("UBI")
e5bce247 SG	182	.load = env_ubi_load,
e5bce247 SG	183	.save = env_save_ptr(env_ubi_save),
4415f1d1	184	};