[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)
{
	*env_addr = CONFIG_ENV_OFFSET;
#ifdef CONFIG_ENV_OFFSET_REDUND
	if (copy)
		*env_addr = CONFIG_ENV_OFFSET_REDUND;
#endif
	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 MH	55	{
97039ab9 MH	56	*env_addr = CONFIG_ENV_OFFSET;
d196bd88 MH	57	#ifdef CONFIG_ENV_OFFSET_REDUND
	58	if (copy)
	59	*env_addr = CONFIG_ENV_OFFSET_REDUND;
	60	#endif
97039ab9 MH	61	return 0;
97039ab9 MH	62	}
97039ab9	63
a8060359 TL	64	int env_init(void)
	65	{
	66	/* use default */
e8db8f71 IG	67	gd->env_addr = (ulong)&default_environment[0];
e8db8f71 IG	68	gd->env_valid = 1;
a8060359 TL	69
	70	return 0;
	71	}
	72
e8db8f71	73	static int init_mmc_for_env(struct mmc *mmc)
a8060359 TL	74	{
	75	if (!mmc) {
	76	puts("No MMC card found\n");
	77	return -1;
	78	}
	79
	80	if (mmc_init(mmc)) {
	81	puts("MMC init failed\n");
e8db8f71	82	return -1;
a8060359 TL	83	}
a8060359 TL	84
9404a5fc SW	85	#ifdef CONFIG_SYS_MMC_ENV_PART
	86	if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num) {
	87	if (mmc_switch_part(CONFIG_SYS_MMC_ENV_DEV,
	88	CONFIG_SYS_MMC_ENV_PART)) {
	89	puts("MMC partition switch failed\n");
	90	return -1;
	91	}
	92	}
	93	#endif
	94
a8060359 TL	95	return 0;
	96	}
	97
9404a5fc SW	98	static void fini_mmc_for_env(struct mmc *mmc)
	99	{
	100	#ifdef CONFIG_SYS_MMC_ENV_PART
	101	if (CONFIG_SYS_MMC_ENV_PART != mmc->part_num)
	102	mmc_switch_part(CONFIG_SYS_MMC_ENV_DEV,
	103	mmc->part_num);
	104	#endif
	105	}
	106
a8060359	107	#ifdef CONFIG_CMD_SAVEENV
e8db8f71 IG	108	static inline int write_env(struct mmc *mmc, unsigned long size,
e8db8f71 IG	109	unsigned long offset, const void *buffer)
a8060359 TL	110	{
	111	uint blk_start, blk_cnt, n;
	112
e8db8f71 IG	113	blk_start = ALIGN(offset, mmc->write_bl_len) / mmc->write_bl_len;
e8db8f71 IG	114	blk_cnt = ALIGN(size, mmc->write_bl_len) / mmc->write_bl_len;
a8060359 TL	115
	116	n = mmc->block_dev.block_write(CONFIG_SYS_MMC_ENV_DEV, blk_start,
	117	blk_cnt, (u_char *)buffer);
	118
	119	return (n == blk_cnt) ? 0 : -1;
	120	}
	121
d196bd88 MH	122	#ifdef CONFIG_ENV_OFFSET_REDUND
	123	static unsigned char env_flags;
	124	#endif
	125
a8060359 TL	126	int saveenv(void)
a8060359 TL	127	{
cd0f4fa1	128	ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
e79f4839 LW	129	ssize_t len;
e79f4839 LW	130	char *res;
a8060359	131	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
e8db8f71	132	u32 offset;
d196bd88	133	int ret, copy = 0;
a8060359	134
9404a5fc	135	if (init_mmc_for_env(mmc))
97039ab9 MH	136	return 1;
97039ab9 MH	137
cd0f4fa1	138	res = (char *)&env_new->data;
be11235a	139	len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
e79f4839 LW	140	if (len < 0) {
e79f4839 LW	141	error("Cannot export environment: errno = %d\n", errno);
9404a5fc SW	142	ret = 1;
9404a5fc SW	143	goto fini;
e79f4839	144	}
e8db8f71	145
cd0f4fa1	146	env_new->crc = crc32(0, &env_new->data[0], ENV_SIZE);
d196bd88 MH	147
	148	#ifdef CONFIG_ENV_OFFSET_REDUND
	149	env_new->flags = ++env_flags; /* increase the serial */
	150
	151	if (gd->env_valid == 1)
	152	copy = 1;
	153	#endif
	154
	155	if (mmc_get_env_addr(mmc, copy, &offset)) {
	156	ret = 1;
	157	goto fini;
	158	}
	159
	160	printf("Writing to %sMMC(%d)... ", copy ? "redundant " : "",
	161	CONFIG_SYS_MMC_ENV_DEV);
4036b630	162	if (write_env(mmc, CONFIG_ENV_SIZE, offset, (u_char *)env_new)) {
a8060359	163	puts("failed\n");
9404a5fc SW	164	ret = 1;
9404a5fc SW	165	goto fini;
a8060359 TL	166	}
	167
	168	puts("done\n");
9404a5fc SW	169	ret = 0;
9404a5fc SW	170
d196bd88 MH	171	#ifdef CONFIG_ENV_OFFSET_REDUND
	172	gd->env_valid = gd->env_valid == 2 ? 1 : 2;
	173	#endif
	174
9404a5fc SW	175	fini:
	176	fini_mmc_for_env(mmc);
	177	return ret;
a8060359 TL	178	}
	179	#endif /* CONFIG_CMD_SAVEENV */
	180
e8db8f71 IG	181	static inline int read_env(struct mmc *mmc, unsigned long size,
e8db8f71 IG	182	unsigned long offset, const void *buffer)
a8060359 TL	183	{
	184	uint blk_start, blk_cnt, n;
	185
e8db8f71 IG	186	blk_start = ALIGN(offset, mmc->read_bl_len) / mmc->read_bl_len;
e8db8f71 IG	187	blk_cnt = ALIGN(size, mmc->read_bl_len) / mmc->read_bl_len;
a8060359 TL	188
	189	n = mmc->block_dev.block_read(CONFIG_SYS_MMC_ENV_DEV, blk_start,
	190	blk_cnt, (uchar *)buffer);
	191
	192	return (n == blk_cnt) ? 0 : -1;
	193	}
	194
d196bd88 MH	195	#ifdef CONFIG_ENV_OFFSET_REDUND
	196	void env_relocate_spec(void)
	197	{
	198	#if !defined(ENV_IS_EMBEDDED)
	199	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
	200	u32 offset1, offset2;
	201	int read1_fail = 0, read2_fail = 0;
	202	int crc1_ok = 0, crc2_ok = 0;
	203	env_t ep, tmp_env1, *tmp_env2;
	204	int ret;
	205
	206	tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
	207	tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
	208	if (tmp_env1 == NULL \|\| tmp_env2 == NULL) {
	209	puts("Can't allocate buffers for environment\n");
	210	ret = 1;
	211	goto err;
	212	}
	213
	214	if (init_mmc_for_env(mmc)) {
	215	ret = 1;
	216	goto err;
	217	}
	218
	219	if (mmc_get_env_addr(mmc, 0, &offset1) \|\|
	220	mmc_get_env_addr(mmc, 1, &offset2)) {
	221	ret = 1;
	222	goto fini;
	223	}
	224
	225	read1_fail = read_env(mmc, CONFIG_ENV_SIZE, offset1, tmp_env1);
	226	read2_fail = read_env(mmc, CONFIG_ENV_SIZE, offset2, tmp_env2);
	227
	228	if (read1_fail && read2_fail)
	229	puts("*** Error - No Valid Environment Area found\n");
	230	else if (read1_fail \|\| read2_fail)
	231	puts("*** Warning - some problems detected "
	232	"reading environment; recovered successfully\n");
	233
	234	crc1_ok = !read1_fail &&
	235	(crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
	236	crc2_ok = !read2_fail &&
	237	(crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
	238
	239	if (!crc1_ok && !crc2_ok) {
	240	ret = 1;
	241	goto fini;
	242	} else if (crc1_ok && !crc2_ok) {
	243	gd->env_valid = 1;
	244	} else if (!crc1_ok && crc2_ok) {
	245	gd->env_valid = 2;
	246	} else {
	247	/* both ok - check serial */
	248	if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
	249	gd->env_valid = 2;
	250	else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
	251	gd->env_valid = 1;
	252	else if (tmp_env1->flags > tmp_env2->flags)
	253	gd->env_valid = 1;
	254	else if (tmp_env2->flags > tmp_env1->flags)
	255	gd->env_valid = 2;
	256	else /* flags are equal - almost impossible */
	257	gd->env_valid = 1;
	258	}
259
260	free(env_ptr);
261
262	if (gd->env_valid == 1)
263	ep = tmp_env1;
264	else
265	ep = tmp_env2;
266
267	env_flags = ep->flags;
268	env_import((char *)ep, 0);
269	ret = 0;
270
271	fini:
272	fini_mmc_for_env(mmc);
273	err:
274	if (ret)
275	set_default_env(NULL);
276
277	free(tmp_env1);
278	free(tmp_env2);
279	#endif
280	}
281	#else /* ! CONFIG_ENV_OFFSET_REDUND */
a8060359 TL	282	void env_relocate_spec(void)
	283	{
	284	#if !defined(ENV_IS_EMBEDDED)
cd0f4fa1	285	ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
a8060359	286	struct mmc *mmc = find_mmc_device(CONFIG_SYS_MMC_ENV_DEV);
97039ab9	287	u32 offset;
9404a5fc	288	int ret;
a8060359	289
9404a5fc SW	290	if (init_mmc_for_env(mmc)) {
	291	ret = 1;
	292	goto err;
	293	}
a8060359	294
d196bd88	295	if (mmc_get_env_addr(mmc, 0, &offset)) {
9404a5fc SW	296	ret = 1;
	297	goto fini;
	298	}
	299
cd0f4fa1	300	if (read_env(mmc, CONFIG_ENV_SIZE, offset, buf)) {
9404a5fc SW	301	ret = 1;
	302	goto fini;
	303	}
a8060359	304
cd0f4fa1	305	env_import(buf, 1);
9404a5fc SW	306	ret = 0;
	307
	308	fini:
	309	fini_mmc_for_env(mmc);
	310	err:
	311	if (ret)
	312	set_default_env(NULL);
a8060359 TL	313	#endif
a8060359 TL	314	}
d196bd88	315	#endif /* CONFIG_ENV_OFFSET_REDUND */