[people/ms/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 <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;
}

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 int mmc_set_env_part(struct mmc *mmc)
{
	uint part = mmc_get_env_part(mmc);
	int dev = CONFIG_SYS_MMC_ENV_DEV;
	int ret = 0;

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif

	if (part != mmc->part_num) {
		ret = mmc_switch_part(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 int init_mmc_for_env(struct mmc *mmc)
{
	if (!mmc) {
		puts("No MMC card found\n");
		return -1;
	}

	if (mmc_init(mmc)) {
		puts("MMC init failed\n");
		return -1;
	}

	return mmc_set_env_part(mmc);
}

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

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif
	if (mmc_get_env_part(mmc) != mmc->part_num)
		mmc_switch_part(dev, mmc->part_num);
#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;

	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 = mmc->block_dev.block_write(CONFIG_SYS_MMC_ENV_DEV, 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);
	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
	u32	offset;
	int	ret, copy = 0;

	if (init_mmc_for_env(mmc))
		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 " : "",
	       CONFIG_SYS_MMC_ENV_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;
	int dev = CONFIG_SYS_MMC_ENV_DEV;

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif

	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 = mmc->block_dev.block_read(dev, 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 = CONFIG_SYS_MMC_ENV_DEV;

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

	if (init_mmc_for_env(mmc)) {
		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) {
		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(NULL);

#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 = CONFIG_SYS_MMC_ENV_DEV;

#ifdef CONFIG_SPL_BUILD
	dev = 0;
#endif

	mmc = find_mmc_device(dev);

	if (init_mmc_for_env(mmc)) {
		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)) {
		ret = 1;
		goto fini;
	}

	env_import(buf, 1);
	ret = 0;

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