[J-u-boot.git] / common / env_mmc.c

/*
 * (C) Copyright 2008-2011 Freescale Semiconductor, Inc.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

/* #define DEBUG */

#include <common.h>

#include <command.h>
#include <environment.h>
#include <linux/stddef.h>
#include <malloc.h>
#include <memalign.h>
#include <mmc.h>
#include <search.h>
#include <errno.h>

#if defined(CONFIG_ENV_SIZE_REDUND) &&  \
	(CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
#error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
#endif

char *env_name_spec = "MMC";

#ifdef ENV_IS_EMBEDDED
env_t *env_ptr = &environment;
#else /* ! ENV_IS_EMBEDDED */
env_t *env_ptr;
#endif /* ENV_IS_EMBEDDED */

DECLARE_GLOBAL_DATA_PTR;

#if !defined(CONFIG_ENV_OFFSET)
#define CONFIG_ENV_OFFSET 0
#endif

__weak int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr)
{
	s64 offset;

	offset = CONFIG_ENV_OFFSET;
#ifdef CONFIG_ENV_OFFSET_REDUND
	if (copy)
		offset = CONFIG_ENV_OFFSET_REDUND;
#endif

	if (offset < 0)
		offset += mmc->capacity;

	*env_addr = offset;

	return 0;
}

__weak int mmc_get_env_dev(void)
{
	return CONFIG_SYS_MMC_ENV_DEV;
}

int env_init(void)
{
	/* use default */
	gd->env_addr	= (ulong)&default_environment[0];
	gd->env_valid	= 1;

	return 0;
}

#ifdef CONFIG_SYS_MMC_ENV_PART
__weak uint mmc_get_env_part(struct mmc *mmc)
{
	return CONFIG_SYS_MMC_ENV_PART;
}

static unsigned char env_mmc_orig_hwpart;

static int mmc_set_env_part(struct mmc *mmc)
{
	uint part = mmc_get_env_part(mmc);
	int dev = mmc_get_env_dev();
	int ret = 0;

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif

	env_mmc_orig_hwpart = mmc_get_blk_desc(mmc)->hwpart;
	ret = blk_select_hwpart_devnum(IF_TYPE_MMC, dev, part);
	if (ret)
		puts("MMC partition switch failed\n");

	return ret;
}
#else
static inline int mmc_set_env_part(struct mmc *mmc) {return 0; };
#endif

static const char *init_mmc_for_env(struct mmc *mmc)
{
	if (!mmc)
		return "!No MMC card found";

	if (mmc_init(mmc))
		return "!MMC init failed";

	if (mmc_set_env_part(mmc))
		return "!MMC partition switch failed";

	return NULL;
}

static void fini_mmc_for_env(struct mmc *mmc)
{
#ifdef CONFIG_SYS_MMC_ENV_PART
	int dev = mmc_get_env_dev();

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif
	blk_select_hwpart_devnum(IF_TYPE_MMC, dev, env_mmc_orig_hwpart);
#endif
}

#ifdef CONFIG_CMD_SAVEENV
static inline int write_env(struct mmc *mmc, unsigned long size,
			    unsigned long offset, const void *buffer)
{
	uint blk_start, blk_cnt, n;
	struct blk_desc *desc = mmc_get_blk_desc(mmc);

	blk_start	= ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
	blk_cnt		= ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;

	n = blk_dwrite(desc, blk_start, blk_cnt, (u_char *)buffer);

	return (n == blk_cnt) ? 0 : -1;
}

#ifdef CONFIG_ENV_OFFSET_REDUND
static unsigned char env_flags;
#endif

int saveenv(void)
{
	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
	int dev = mmc_get_env_dev();
	struct mmc *mmc = find_mmc_device(dev);
	u32	offset;
	int	ret, copy = 0;
	const char *errmsg;

	errmsg = init_mmc_for_env(mmc);
	if (errmsg) {
		printf("%s\n", errmsg);
		return 1;
	}

	ret = env_export(env_new);
	if (ret)
		goto fini;

#ifdef CONFIG_ENV_OFFSET_REDUND
	env_new->flags	= ++env_flags; /* increase the serial */

	if (gd->env_valid == 1)
		copy = 1;
#endif

	if (mmc_get_env_addr(mmc, copy, &offset)) {
		ret = 1;
		goto fini;
	}

	printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "", dev);
	if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
		puts("failed\n");
		ret = 1;
		goto fini;
	}

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

#ifdef CONFIG_ENV_OFFSET_REDUND
	gd->env_valid = gd->env_valid == 2 ? 1 : 2;
#endif

fini:
	fini_mmc_for_env(mmc);
	return ret;
}
#endif /* CONFIG_CMD_SAVEENV */

static inline int read_env(struct mmc *mmc, unsigned long size,
			   unsigned long offset, const void *buffer)
{
	uint blk_start, blk_cnt, n;
	struct blk_desc *desc = mmc_get_blk_desc(mmc);

	blk_start	= ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
	blk_cnt		= ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;

	n = blk_dread(desc, blk_start, blk_cnt, (uchar *)buffer);

	return (n == blk_cnt) ? 0 : -1;
}

#ifdef CONFIG_ENV_OFFSET_REDUND
void env_relocate_spec(void)
{
#if !defined(ENV_IS_EMBEDDED)
	struct mmc *mmc;
	u32 offset1, offset2;
	int read1_fail = 0, read2_fail = 0;
	int crc1_ok = 0, crc2_ok = 0;
	env_t *ep;
	int ret;
	int dev = mmc_get_env_dev();
	const char *errmsg = NULL;

	ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
	ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif

	mmc = find_mmc_device(dev);

	errmsg = init_mmc_for_env(mmc);
	if (errmsg) {
		ret = 1;
		goto err;
	}

	if (mmc_get_env_addr(mmc, 0, &offset1) ||
	    mmc_get_env_addr(mmc, 1, &offset2)) {
		ret = 1;
		goto fini;
	}

	read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
	read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);

	if (read1_fail && read2_fail)
		puts("*** Error - No Valid Environment Area found\n");
	else if (read1_fail || read2_fail)
		puts("*** Warning - some problems detected "
		     "reading environment; recovered successfully\n");

	crc1_ok = !read1_fail &&
		(crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
	crc2_ok = !read2_fail &&
		(crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);

	if (!crc1_ok && !crc2_ok) {
		errmsg = "!bad CRC";
		ret = 1;
		goto fini;
	} else if (crc1_ok && !crc2_ok) {
		gd->env_valid = 1;
	} else if (!crc1_ok && crc2_ok) {
		gd->env_valid = 2;
	} else {
		/* both ok - check serial */
		if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
			gd->env_valid = 2;
		else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
			gd->env_valid = 1;
		else if (tmp_env1->flags > tmp_env2->flags)
			gd->env_valid = 1;
		else if (tmp_env2->flags > tmp_env1->flags)
			gd->env_valid = 2;
		else /* flags are equal - almost impossible */
			gd->env_valid = 1;
	}

	free(env_ptr);

	if (gd->env_valid == 1)
		ep = tmp_env1;
	else
		ep = tmp_env2;

	env_flags = ep->flags;
	env_import((char *)ep, 0);
	ret = 0;

fini:
	fini_mmc_for_env(mmc);
err:
	if (ret)
		set_default_env(errmsg);
#endif
}
#else /* ! CONFIG_ENV_OFFSET_REDUND */
void env_relocate_spec(void)
{
#if !defined(ENV_IS_EMBEDDED)
	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
	struct mmc *mmc;
	u32 offset;
	int ret;
	int dev = mmc_get_env_dev();
	const char *errmsg;

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif

	mmc = find_mmc_device(dev);

	errmsg = init_mmc_for_env(mmc);
	if (errmsg) {
		ret = 1;
		goto err;
	}

	if (mmc_get_env_addr(mmc, 0, &offset)) {
		ret = 1;
		goto fini;
	}

	if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
		errmsg = "!read failed";
		ret = 1;
		goto fini;
	}

	env_import(buf, 1);
	ret = 0;

fini:
	fini_mmc_for_env(mmc);
err:
	if (ret)
		set_default_env(errmsg);
#endif
}
#endif /* CONFIG_ENV_OFFSET_REDUND */
Commit	Line	Data
a8060359	1	/*
97039ab9	2	* (C) Copyright 2008-2011 Freescale Semiconductor, Inc.
a8060359	3	*
3765b3e7	4	* SPDX-License-Identifier: GPL-2.0+
a8060359 TL	5	*/
	6
	7	/* #define DEBUG */
	8
	9	#include <common.h>
	10
	11	#include <command.h>
	12	#include <environment.h>
	13	#include <linux/stddef.h>
	14	#include <malloc.h>
cf92e05c	15	#include <memalign.h>
a8060359	16	#include <mmc.h>
6d1d51b3	17	#include <search.h>
e79f4839	18	#include <errno.h>
a8060359	19
d196bd88 MH	20	#if defined(CONFIG_ENV_SIZE_REDUND) && \
	21	(CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
	22	#error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
	23	#endif
	24
a8060359 TL	25	char *env_name_spec = "MMC";
	26
	27	#ifdef ENV_IS_EMBEDDED
994bc671	28	env_t *env_ptr = &environment;
a8060359	29	#else /* ! ENV_IS_EMBEDDED */
e8db8f71	30	env_t *env_ptr;
a8060359 TL	31	#endif /* ENV_IS_EMBEDDED */
a8060359 TL	32
a8060359 TL	33	DECLARE_GLOBAL_DATA_PTR;
a8060359 TL	34
97039ab9 MH	35	#if !defined(CONFIG_ENV_OFFSET)
	36	#define CONFIG_ENV_OFFSET 0
	37	#endif
	38
d196bd88	39	__weak int mmc_get_env_addr(struct mmc mmc, int copy, u32 env_addr)
97039ab9	40	{
5c088ee8 SW	41	s64 offset;
	42
	43	offset = CONFIG_ENV_OFFSET;
d196bd88 MH	44	#ifdef CONFIG_ENV_OFFSET_REDUND
d196bd88 MH	45	if (copy)
5c088ee8	46	offset = CONFIG_ENV_OFFSET_REDUND;
d196bd88	47	#endif
5c088ee8 SW	48
	49	if (offset < 0)
	50	offset += mmc->capacity;
	51
	52	*env_addr = offset;
	53
97039ab9 MH	54	return 0;
97039ab9 MH	55	}
97039ab9	56
e92029c0 CG	57	__weak int mmc_get_env_dev(void)
	58	{
	59	return CONFIG_SYS_MMC_ENV_DEV;
	60	}
	61
a8060359 TL	62	int env_init(void)
	63	{
	64	/* use default */
e8db8f71 IG	65	gd->env_addr = (ulong)&default_environment[0];
e8db8f71 IG	66	gd->env_valid = 1;
a8060359 TL	67
	68	return 0;
	69	}
	70
b9c8ccab	71	#ifdef CONFIG_SYS_MMC_ENV_PART
6e7b7df4 DL	72	__weak uint mmc_get_env_part(struct mmc *mmc)
	73	{
	74	return CONFIG_SYS_MMC_ENV_PART;
	75	}
	76
873cc1d7 SW	77	static unsigned char env_mmc_orig_hwpart;
873cc1d7 SW	78
6e7b7df4 DL	79	static int mmc_set_env_part(struct mmc *mmc)
	80	{
	81	uint part = mmc_get_env_part(mmc);
e92029c0	82	int dev = mmc_get_env_dev();
6e7b7df4	83	int ret = 0;
b9c8ccab TR	84
	85	#ifdef CONFIG_SPL_BUILD
	86	dev = 0;
	87	#endif
6e7b7df4	88
69f45cd5 SG	89	env_mmc_orig_hwpart = mmc_get_blk_desc(mmc)->hwpart;
69f45cd5 SG	90	ret = blk_select_hwpart_devnum(IF_TYPE_MMC, dev, part);
873cc1d7 SW	91	if (ret)
873cc1d7 SW	92	puts("MMC partition switch failed\n");
6e7b7df4 DL	93
	94	return ret;
	95	}
	96	#else
	97	static inline int mmc_set_env_part(struct mmc *mmc) {return 0; };
b9c8ccab TR	98	#endif
b9c8ccab TR	99
c75648d7	100	static const char init_mmc_for_env(struct mmc mmc)
6e7b7df4	101	{
c75648d7	102	if (!mmc)
a85da21f	103	return "!No MMC card found";
a8060359	104
c75648d7	105	if (mmc_init(mmc))
a85da21f	106	return "!MMC init failed";
c75648d7 TH	107
c75648d7 TH	108	if (mmc_set_env_part(mmc))
a85da21f	109	return "!MMC partition switch failed";
a8060359	110
c75648d7	111	return NULL;
a8060359 TL	112	}
a8060359 TL	113
9404a5fc SW	114	static void fini_mmc_for_env(struct mmc *mmc)
	115	{
	116	#ifdef CONFIG_SYS_MMC_ENV_PART
e92029c0	117	int dev = mmc_get_env_dev();
b9c8ccab TR	118
	119	#ifdef CONFIG_SPL_BUILD
	120	dev = 0;
	121	#endif
69f45cd5	122	blk_select_hwpart_devnum(IF_TYPE_MMC, dev, env_mmc_orig_hwpart);
9404a5fc SW	123	#endif
	124	}
	125
a8060359	126	#ifdef CONFIG_CMD_SAVEENV
e8db8f71 IG	127	static inline int write_env(struct mmc *mmc, unsigned long size,
e8db8f71 IG	128	unsigned long offset, const void *buffer)
a8060359 TL	129	{
a8060359 TL	130	uint blk_start, blk_cnt, n;
5461acba	131	struct blk_desc *desc = mmc_get_blk_desc(mmc);
a8060359	132
e8db8f71 IG	133	blk_start = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
e8db8f71 IG	134	blk_cnt = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
a8060359	135
5461acba	136	n = blk_dwrite(desc, blk_start, blk_cnt, (u_char *)buffer);
a8060359 TL	137
	138	return (n == blk_cnt) ? 0 : -1;
	139	}
	140
d196bd88 MH	141	#ifdef CONFIG_ENV_OFFSET_REDUND
	142	static unsigned char env_flags;
	143	#endif
	144
a8060359 TL	145	int saveenv(void)
a8060359 TL	146	{
cd0f4fa1	147	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
e92029c0 CG	148	int dev = mmc_get_env_dev();
e92029c0 CG	149	struct mmc *mmc = find_mmc_device(dev);
e8db8f71	150	u32 offset;
d196bd88	151	int ret, copy = 0;
c75648d7	152	const char *errmsg;
a8060359	153
c75648d7 TH	154	errmsg = init_mmc_for_env(mmc);
	155	if (errmsg) {
	156	printf("%s\n", errmsg);
97039ab9	157	return 1;
c75648d7	158	}
97039ab9	159
7ce1526e MV	160	ret = env_export(env_new);
7ce1526e MV	161	if (ret)
9404a5fc	162	goto fini;
d196bd88 MH	163
	164	#ifdef CONFIG_ENV_OFFSET_REDUND
	165	env_new->flags = ++env_flags; /* increase the serial */
	166
	167	if (gd->env_valid == 1)
	168	copy = 1;
	169	#endif
	170
	171	if (mmc_get_env_addr(mmc, copy, &offset)) {
	172	ret = 1;
	173	goto fini;
	174	}
	175
e92029c0	176	printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "", dev);
4036b630	177	if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
a8060359	178	puts("failed\n");
9404a5fc SW	179	ret = 1;
9404a5fc SW	180	goto fini;
a8060359 TL	181	}
	182
	183	puts("done\n");
9404a5fc SW	184	ret = 0;
9404a5fc SW	185
d196bd88 MH	186	#ifdef CONFIG_ENV_OFFSET_REDUND
	187	gd->env_valid = gd->env_valid == 2 ? 1 : 2;
	188	#endif
	189
9404a5fc SW	190	fini:
	191	fini_mmc_for_env(mmc);
	192	return ret;
a8060359 TL	193	}
	194	#endif /* CONFIG_CMD_SAVEENV */
	195
e8db8f71 IG	196	static inline int read_env(struct mmc *mmc, unsigned long size,
e8db8f71 IG	197	unsigned long offset, const void *buffer)
a8060359 TL	198	{
a8060359 TL	199	uint blk_start, blk_cnt, n;
5461acba	200	struct blk_desc *desc = mmc_get_blk_desc(mmc);
a8060359	201
e8db8f71 IG	202	blk_start = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
e8db8f71 IG	203	blk_cnt = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
a8060359	204
5461acba	205	n = blk_dread(desc, blk_start, blk_cnt, (uchar *)buffer);
a8060359 TL	206
	207	return (n == blk_cnt) ? 0 : -1;
	208	}
	209
d196bd88 MH	210	#ifdef CONFIG_ENV_OFFSET_REDUND
	211	void env_relocate_spec(void)
	212	{
	213	#if !defined(ENV_IS_EMBEDDED)
b9c8ccab	214	struct mmc *mmc;
d196bd88 MH	215	u32 offset1, offset2;
	216	int read1_fail = 0, read2_fail = 0;
	217	int crc1_ok = 0, crc2_ok = 0;
452a2722	218	env_t *ep;
d196bd88	219	int ret;
e92029c0	220	int dev = mmc_get_env_dev();
c75648d7	221	const char *errmsg = NULL;
d196bd88	222
452a2722 MN	223	ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env1, 1);
	224	ALLOC_CACHE_ALIGN_BUFFER(env_t, tmp_env2, 1);
	225
b9c8ccab TR	226	#ifdef CONFIG_SPL_BUILD
	227	dev = 0;
	228	#endif
	229
	230	mmc = find_mmc_device(dev);
	231
c75648d7 TH	232	errmsg = init_mmc_for_env(mmc);
c75648d7 TH	233	if (errmsg) {
d196bd88 MH	234	ret = 1;
	235	goto err;
	236	}
	237
	238	if (mmc_get_env_addr(mmc, 0, &offset1) \|\|
	239	mmc_get_env_addr(mmc, 1, &offset2)) {
	240	ret = 1;
	241	goto fini;
	242	}
	243
	244	read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
	245	read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
	246
	247	if (read1_fail && read2_fail)
	248	puts("*** Error - No Valid Environment Area found\n");
	249	else if (read1_fail \|\| read2_fail)
	250	puts("*** Warning - some problems detected "
	251	"reading environment; recovered successfully\n");
	252
	253	crc1_ok = !read1_fail &&
	254	(crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
	255	crc2_ok = !read2_fail &&
	256	(crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
	257
	258	if (!crc1_ok && !crc2_ok) {
c75648d7	259	errmsg = "!bad CRC";
d196bd88 MH	260	ret = 1;
	261	goto fini;
	262	} else if (crc1_ok && !crc2_ok) {
	263	gd->env_valid = 1;
	264	} else if (!crc1_ok && crc2_ok) {
	265	gd->env_valid = 2;
	266	} else {
	267	/* both ok - check serial */
	268	if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
	269	gd->env_valid = 2;
	270	else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
	271	gd->env_valid = 1;
	272	else if (tmp_env1->flags > tmp_env2->flags)
	273	gd->env_valid = 1;
	274	else if (tmp_env2->flags > tmp_env1->flags)
	275	gd->env_valid = 2;
	276	else /* flags are equal - almost impossible */
	277	gd->env_valid = 1;
	278	}
	279
	280	free(env_ptr);
	281
	282	if (gd->env_valid == 1)
	283	ep = tmp_env1;
	284	else
	285	ep = tmp_env2;
	286
	287	env_flags = ep->flags;
	288	env_import((char *)ep, 0);
	289	ret = 0;
	290
	291	fini:
	292	fini_mmc_for_env(mmc);
	293	err:
	294	if (ret)
c75648d7	295	set_default_env(errmsg);
d196bd88 MH	296	#endif
	297	}
	298	#else /* ! CONFIG_ENV_OFFSET_REDUND */
a8060359 TL	299	void env_relocate_spec(void)
	300	{
	301	#if !defined(ENV_IS_EMBEDDED)
cd0f4fa1	302	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
b9c8ccab	303	struct mmc *mmc;
97039ab9	304	u32 offset;
9404a5fc	305	int ret;
e92029c0	306	int dev = mmc_get_env_dev();
c75648d7	307	const char *errmsg;
b9c8ccab TR	308
	309	#ifdef CONFIG_SPL_BUILD
	310	dev = 0;
	311	#endif
	312
	313	mmc = find_mmc_device(dev);
a8060359	314
c75648d7 TH	315	errmsg = init_mmc_for_env(mmc);
c75648d7 TH	316	if (errmsg) {
9404a5fc SW	317	ret = 1;
	318	goto err;
	319	}
a8060359	320
d196bd88	321	if (mmc_get_env_addr(mmc, 0, &offset)) {
9404a5fc SW	322	ret = 1;
	323	goto fini;
	324	}
	325
cd0f4fa1	326	if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
c75648d7	327	errmsg = "!read failed";
9404a5fc SW	328	ret = 1;
	329	goto fini;
	330	}
a8060359	331
cd0f4fa1	332	env_import(buf, 1);
9404a5fc SW	333	ret = 0;
	334
	335	fini:
	336	fini_mmc_for_env(mmc);
	337	err:
	338	if (ret)
c75648d7	339	set_default_env(errmsg);
a8060359 TL	340	#endif
a8060359 TL	341	}
d196bd88	342	#endif /* CONFIG_ENV_OFFSET_REDUND */