[people/ms/u-boot.git] / common / env_mmc.c

/*
 * (C) Copyright 2008-2011 Freescale Semiconductor, Inc.
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

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

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

#ifdef CONFIG_SYS_MMC_ENV_PART
	if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num) {
		if (mmc_switch_part(CONFIG_SYS_MMC_ENV_DEV,
				    CONFIG_SYS_MMC_ENV_PART)) {
			puts("MMC partition switch failed\n");
			return -1;
		}
	}
#endif

	return 0;
}

static void fini_mmc_for_env(struct mmc *mmc)
{
#ifdef CONFIG_SYS_MMC_ENV_PART
	if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num)
		mmc_switch_part(CONFIG_SYS_MMC_ENV_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);
	ssize_t	len;
	char	*res;
	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;

	res = (char *)&env_new->data;
	len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
	if (len < 0) {
		error("Cannot export environment: errno = %d\n", errno);
		ret = 1;
		goto fini;
	}

	env_new->crc = crc32(0, &env_new->data[0], ENV_SIZE);

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

	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(CONFIG_SYS_MMC_ENV_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 = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
	u32 offset1, offset2;
	int read1_fail = 0, read2_fail = 0;
	int crc1_ok = 0, crc2_ok = 0;
	env_t *ep, *tmp_env1, *tmp_env2;
	int ret;

	tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
	tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
	if (tmp_env1 == NULL || tmp_env2 == NULL) {
		puts("Can't allocate buffers for environment\n");
		ret = 1;
		goto err;
	}

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

	free(tmp_env1);
	free(tmp_env2);
#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 = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
	u32 offset;
	int ret;

	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 TL	3	*
	4	* See file CREDITS for list of people who contributed to this
	5	* project.
	6	*
	7	* This program is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU General Public License as
	9	* published by the Free Software Foundation; either version 2 of
	10	* the License, or (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	20	* MA 02111-1307 USA
	21	*/
	22
	23	/* #define DEBUG */
	24
	25	#include <common.h>
	26
	27	#include <command.h>
	28	#include <environment.h>
	29	#include <linux/stddef.h>
	30	#include <malloc.h>
	31	#include <mmc.h>
6d1d51b3	32	#include <search.h>
e79f4839	33	#include <errno.h>
a8060359	34
d196bd88 MH	35	#if defined(CONFIG_ENV_SIZE_REDUND) && \
	36	(CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
	37	#error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
	38	#endif
	39
a8060359 TL	40	char *env_name_spec = "MMC";
	41
	42	#ifdef ENV_IS_EMBEDDED
994bc671	43	env_t *env_ptr = &environment;
a8060359	44	#else /* ! ENV_IS_EMBEDDED */
e8db8f71	45	env_t *env_ptr;
a8060359 TL	46	#endif /* ENV_IS_EMBEDDED */
a8060359 TL	47
a8060359 TL	48	DECLARE_GLOBAL_DATA_PTR;
a8060359 TL	49
97039ab9 MH	50	#if !defined(CONFIG_ENV_OFFSET)
	51	#define CONFIG_ENV_OFFSET 0
	52	#endif
	53
d196bd88	54	__weak int mmc_get_env_addr(struct mmc mmc, int copy, u32 env_addr)
97039ab9	55	{
5c088ee8 SW	56	s64 offset;
	57
	58	offset = CONFIG_ENV_OFFSET;
d196bd88 MH	59	#ifdef CONFIG_ENV_OFFSET_REDUND
d196bd88 MH	60	if (copy)
5c088ee8	61	offset = CONFIG_ENV_OFFSET_REDUND;
d196bd88	62	#endif
5c088ee8 SW	63
	64	if (offset < 0)
	65	offset += mmc->capacity;
	66
	67	*env_addr = offset;
	68
97039ab9 MH	69	return 0;
97039ab9 MH	70	}
97039ab9	71
a8060359 TL	72	int env_init(void)
	73	{
	74	/* use default */
e8db8f71 IG	75	gd->env_addr = (ulong)&default_environment[0];
e8db8f71 IG	76	gd->env_valid = 1;
a8060359 TL	77
	78	return 0;
	79	}
	80
e8db8f71	81	static int init_mmc_for_env(struct mmc *mmc)
a8060359 TL	82	{
	83	if (!mmc) {
	84	puts("No MMC card found\n");
	85	return -1;
	86	}
	87
	88	if (mmc_init(mmc)) {
	89	puts("MMC init failed\n");
e8db8f71	90	return -1;
a8060359 TL	91	}
a8060359 TL	92
9404a5fc SW	93	#ifdef CONFIG_SYS_MMC_ENV_PART
	94	if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num) {
	95	if (mmc_switch_part(CONFIG_SYS_MMC_ENV_DEV,
	96	CONFIG_SYS_MMC_ENV_PART)) {
	97	puts("MMC partition switch failed\n");
	98	return -1;
	99	}
	100	}
	101	#endif
	102
a8060359 TL	103	return 0;
	104	}
	105
9404a5fc SW	106	static void fini_mmc_for_env(struct mmc *mmc)
	107	{
	108	#ifdef CONFIG_SYS_MMC_ENV_PART
	109	if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num)
	110	mmc_switch_part(CONFIG_SYS_MMC_ENV_DEV,
	111	mmc->part_num);
	112	#endif
	113	}
	114
a8060359	115	#ifdef CONFIG_CMD_SAVEENV
e8db8f71 IG	116	static inline int write_env(struct mmc *mmc, unsigned long size,
e8db8f71 IG	117	unsigned long offset, const void *buffer)
a8060359 TL	118	{
	119	uint blk_start, blk_cnt, n;
	120
e8db8f71 IG	121	blk_start = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
e8db8f71 IG	122	blk_cnt = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
a8060359 TL	123
	124	n = mmc->block_dev.block_write(CONFIG_SYS_MMC_ENV_DEV, blk_start,
	125	blk_cnt, (u_char *)buffer);
	126
	127	return (n == blk_cnt) ? 0 : -1;
	128	}
	129
d196bd88 MH	130	#ifdef CONFIG_ENV_OFFSET_REDUND
	131	static unsigned char env_flags;
	132	#endif
	133
a8060359 TL	134	int saveenv(void)
a8060359 TL	135	{
cd0f4fa1	136	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
e79f4839 LW	137	ssize_t len;
e79f4839 LW	138	char *res;
a8060359	139	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
e8db8f71	140	u32 offset;
d196bd88	141	int ret, copy = 0;
a8060359	142
9404a5fc	143	if (init_mmc_for_env(mmc))
97039ab9 MH	144	return 1;
97039ab9 MH	145
cd0f4fa1	146	res = (char *)&env_new->data;
be11235a	147	len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
e79f4839 LW	148	if (len < 0) {
e79f4839 LW	149	error("Cannot export environment: errno = %d\n", errno);
9404a5fc SW	150	ret = 1;
9404a5fc SW	151	goto fini;
e79f4839	152	}
e8db8f71	153
cd0f4fa1	154	env_new->crc = crc32(0, &env_new->data[0], ENV_SIZE);
d196bd88 MH	155
	156	#ifdef CONFIG_ENV_OFFSET_REDUND
	157	env_new->flags = ++env_flags; /* increase the serial */
	158
	159	if (gd->env_valid == 1)
	160	copy = 1;
	161	#endif
	162
	163	if (mmc_get_env_addr(mmc, copy, &offset)) {
	164	ret = 1;
	165	goto fini;
	166	}
	167
	168	printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "",
	169	CONFIG_SYS_MMC_ENV_DEV);
4036b630	170	if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
a8060359	171	puts("failed\n");
9404a5fc SW	172	ret = 1;
9404a5fc SW	173	goto fini;
a8060359 TL	174	}
	175
	176	puts("done\n");
9404a5fc SW	177	ret = 0;
9404a5fc SW	178
d196bd88 MH	179	#ifdef CONFIG_ENV_OFFSET_REDUND
	180	gd->env_valid = gd->env_valid == 2 ? 1 : 2;
	181	#endif
	182
9404a5fc SW	183	fini:
	184	fini_mmc_for_env(mmc);
	185	return ret;
a8060359 TL	186	}
	187	#endif /* CONFIG_CMD_SAVEENV */
	188
e8db8f71 IG	189	static inline int read_env(struct mmc *mmc, unsigned long size,
e8db8f71 IG	190	unsigned long offset, const void *buffer)
a8060359 TL	191	{
	192	uint blk_start, blk_cnt, n;
	193
e8db8f71 IG	194	blk_start = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
e8db8f71 IG	195	blk_cnt = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
a8060359 TL	196
	197	n = mmc->block_dev.block_read(CONFIG_SYS_MMC_ENV_DEV, blk_start,
	198	blk_cnt, (uchar *)buffer);
	199
	200	return (n == blk_cnt) ? 0 : -1;
	201	}
	202
d196bd88 MH	203	#ifdef CONFIG_ENV_OFFSET_REDUND
	204	void env_relocate_spec(void)
	205	{
	206	#if !defined(ENV_IS_EMBEDDED)
	207	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
	208	u32 offset1, offset2;
	209	int read1_fail = 0, read2_fail = 0;
	210	int crc1_ok = 0, crc2_ok = 0;
	211	env_t ep, tmp_env1, *tmp_env2;
	212	int ret;
	213
	214	tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
	215	tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
	216	if (tmp_env1 == NULL \|\| tmp_env2 == NULL) {
	217	puts("Can't allocate buffers for environment\n");
	218	ret = 1;
	219	goto err;
	220	}
	221
	222	if (init_mmc_for_env(mmc)) {
	223	ret = 1;
	224	goto err;
	225	}
	226
	227	if (mmc_get_env_addr(mmc, 0, &offset1) \|\|
	228	mmc_get_env_addr(mmc, 1, &offset2)) {
	229	ret = 1;
	230	goto fini;
	231	}
	232
	233	read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
	234	read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
	235
	236	if (read1_fail && read2_fail)
	237	puts("*** Error - No Valid Environment Area found\n");
	238	else if (read1_fail \|\| read2_fail)
	239	puts("*** Warning - some problems detected "
	240	"reading environment; recovered successfully\n");
	241
	242	crc1_ok = !read1_fail &&
	243	(crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
	244	crc2_ok = !read2_fail &&
	245	(crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
	246
	247	if (!crc1_ok && !crc2_ok) {
	248	ret = 1;
	249	goto fini;
	250	} else if (crc1_ok && !crc2_ok) {
	251	gd->env_valid = 1;
	252	} else if (!crc1_ok && crc2_ok) {
	253	gd->env_valid = 2;
	254	} else {
	255	/* both ok - check serial */
	256	if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
	257	gd->env_valid = 2;
	258	else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
	259	gd->env_valid = 1;
	260	else if (tmp_env1->flags > tmp_env2->flags)
	261	gd->env_valid = 1;
	262	else if (tmp_env2->flags > tmp_env1->flags)
	263	gd->env_valid = 2;
	264	else /* flags are equal - almost impossible */
	265	gd->env_valid = 1;
	266	}
267
268	free(env_ptr);
269
270	if (gd->env_valid == 1)
271	ep = tmp_env1;
272	else
273	ep = tmp_env2;
274
275	env_flags = ep->flags;
276	env_import((char *)ep, 0);
277	ret = 0;
278
279	fini:
280	fini_mmc_for_env(mmc);
281	err:
282	if (ret)
283	set_default_env(NULL);
284
285	free(tmp_env1);
286	free(tmp_env2);
287	#endif
288	}
289	#else /* ! CONFIG_ENV_OFFSET_REDUND */
a8060359 TL	290	void env_relocate_spec(void)
	291	{
	292	#if !defined(ENV_IS_EMBEDDED)
cd0f4fa1	293	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
a8060359	294	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
97039ab9	295	u32 offset;
9404a5fc	296	int ret;
a8060359	297
9404a5fc SW	298	if (init_mmc_for_env(mmc)) {
	299	ret = 1;
	300	goto err;
	301	}
a8060359	302
d196bd88	303	if (mmc_get_env_addr(mmc, 0, &offset)) {
9404a5fc SW	304	ret = 1;
	305	goto fini;
	306	}
	307
cd0f4fa1	308	if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
9404a5fc SW	309	ret = 1;
	310	goto fini;
	311	}
a8060359	312
cd0f4fa1	313	env_import(buf, 1);
9404a5fc SW	314	ret = 0;
	315
	316	fini:
	317	fini_mmc_for_env(mmc);
	318	err:
	319	if (ret)
	320	set_default_env(NULL);
a8060359 TL	321	#endif
a8060359 TL	322	}
d196bd88	323	#endif /* CONFIG_ENV_OFFSET_REDUND */