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

/*
 * (C) Copyright 2004
 * Jian Zhang, Texas Instruments, jzhang@ti.com.

 * (C) Copyright 2000-2004
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
 * Andreas Heppel <aheppel@sysgo.de>

 * 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>

#if defined(CFG_ENV_IS_IN_NAND) /* Environment is in Nand Flash */

#include <command.h>
#include <environment.h>
#include <linux/stddef.h>
#include <malloc.h>
#include <nand.h>

#if ((CONFIG_COMMANDS&(CFG_CMD_ENV|CFG_CMD_NAND)) == (CFG_CMD_ENV|CFG_CMD_NAND))
#define CMD_SAVEENV
#elif defined(CFG_ENV_OFFSET_REDUND)
#error Cannot use CFG_ENV_OFFSET_REDUND without CFG_CMD_ENV & CFG_CMD_NAND
#endif

#if defined(CFG_ENV_SIZE_REDUND) && (CFG_ENV_SIZE_REDUND != CFG_ENV_SIZE)
#error CFG_ENV_SIZE_REDUND should be the same as CFG_ENV_SIZE
#endif

#ifdef CONFIG_INFERNO
#error CONFIG_INFERNO not supported yet
#endif

int nand_legacy_rw (struct nand_chip* nand, int cmd,
	    size_t start, size_t len,
	    size_t * retlen, u_char * buf);

/* info for NAND chips, defined in drivers/nand/nand.c */
extern nand_info_t nand_info[];

/* references to names in env_common.c */
extern uchar default_environment[];
extern int default_environment_size;

char * env_name_spec = "NAND";


#ifdef ENV_IS_EMBEDDED
extern uchar environment[];
env_t *env_ptr = (env_t *)(&environment[0]);
#else /* ! ENV_IS_EMBEDDED */
env_t *env_ptr = 0;
#endif /* ENV_IS_EMBEDDED */


/* local functions */
static void use_default(void);

DECLARE_GLOBAL_DATA_PTR;

uchar env_get_char_spec (int index)
{
	return ( *((uchar *)(gd->env_addr + index)) );
}


/* this is called before nand_init()
 * so we can't read Nand to validate env data.
 * Mark it OK for now. env_relocate() in env_common.c
 * will call our relocate function which will does
 * the real validation.
 */
int env_init(void)
{
	gd->env_addr  = (ulong)&default_environment[0];
	gd->env_valid = 1;

	return (0);
}

#ifdef CMD_SAVEENV
/*
 * The legacy NAND code saved the environment in the first NAND device i.e.,
 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
 */
#ifdef CFG_ENV_OFFSET_REDUND
int saveenv(void)
{
	ulong total;
	int ret = 0;

	env_ptr->flags++;
	total = CFG_ENV_SIZE;

	if(gd->env_valid == 1) {
		puts ("Erasing redundant Nand...");
		if (nand_erase(&nand_info[0],
			       CFG_ENV_OFFSET_REDUND, CFG_ENV_SIZE))
			return 1;
		puts ("Writing to redundant Nand... ");
		ret = nand_write(&nand_info[0], CFG_ENV_OFFSET_REDUND, &total,
				 (u_char*) env_ptr);
	} else {
		puts ("Erasing Nand...");
		if (nand_erase(&nand_info[0],
			       CFG_ENV_OFFSET, CFG_ENV_SIZE))
			return 1;

		puts ("Writing to Nand... ");
		ret = nand_write(&nand_info[0], CFG_ENV_OFFSET, &total,
				 (u_char*) env_ptr);
	}
	if (ret || total != CFG_ENV_SIZE)
		return 1;

	puts ("done\n");
	gd->env_valid = (gd->env_valid == 2 ? 1 : 2);
	return ret;
}
#else /* ! CFG_ENV_OFFSET_REDUND */
int saveenv(void)
{
	ulong total;
	int ret = 0;

	puts ("Erasing Nand...");
	if (nand_erase(&nand_info[0], CFG_ENV_OFFSET, CFG_ENV_SIZE))
		return 1;

	puts ("Writing to Nand... ");
	total = CFG_ENV_SIZE;
	ret = nand_write(&nand_info[0], CFG_ENV_OFFSET, &total, (u_char*)env_ptr);
	if (ret || total != CFG_ENV_SIZE)
		return 1;

	puts ("done\n");
	return ret;
}
#endif /* CFG_ENV_OFFSET_REDUND */
#endif /* CMD_SAVEENV */

#ifdef CFG_ENV_OFFSET_REDUND
void env_relocate_spec (void)
{
#if !defined(ENV_IS_EMBEDDED)
	ulong total;
	int crc1_ok = 0, crc2_ok = 0;
	env_t *tmp_env1, *tmp_env2;

	total = CFG_ENV_SIZE;

	tmp_env1 = (env_t *) malloc(CFG_ENV_SIZE);
	tmp_env2 = (env_t *) malloc(CFG_ENV_SIZE);

	nand_read(&nand_info[0], CFG_ENV_OFFSET, &total,
		  (u_char*) tmp_env1);
	nand_read(&nand_info[0], CFG_ENV_OFFSET_REDUND, &total,
		  (u_char*) tmp_env2);

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

	if(!crc1_ok && !crc2_ok)
		return use_default();
	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) {
		env_ptr = tmp_env1;
		free(tmp_env2);
	} else {
		env_ptr = tmp_env2;
		free(tmp_env1);
	}

#endif /* ! ENV_IS_EMBEDDED */
}
#else /* ! CFG_ENV_OFFSET_REDUND */
/*
 * The legacy NAND code saved the environment in the first NAND device i.e.,
 * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
 */
void env_relocate_spec (void)
{
#if !defined(ENV_IS_EMBEDDED)
	ulong total;
	int ret;

	total = CFG_ENV_SIZE;
	ret = nand_read(&nand_info[0], CFG_ENV_OFFSET, &total, (u_char*)env_ptr);
  	if (ret || total != CFG_ENV_SIZE)
		return use_default();

	if (crc32(0, env_ptr->data, ENV_SIZE) != env_ptr->crc)
		return use_default();
#endif /* ! ENV_IS_EMBEDDED */
}
#endif /* CFG_ENV_OFFSET_REDUND */

static void use_default()
{
	puts ("*** Warning - bad CRC or NAND, using default environment\n\n");

	if (default_environment_size > CFG_ENV_SIZE){
		puts ("*** Error - default environment is too large\n\n");
		return;
	}

	memset (env_ptr, 0, sizeof(env_t));
	memcpy (env_ptr->data,
			default_environment,
			default_environment_size);
	env_ptr->crc = crc32(0, env_ptr->data, ENV_SIZE);
	gd->env_valid = 1;

}

#endif /* CFG_ENV_IS_IN_NAND */
Commit	Line	Data
13a5695b WD	1	/*
	2	* (C) Copyright 2004
	3	* Jian Zhang, Texas Instruments, jzhang@ti.com.
	4
	5	* (C) Copyright 2000-2004
	6	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	7	*
	8	* (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
	9	* Andreas Heppel <aheppel@sysgo.de>
	10
	11	* See file CREDITS for list of people who contributed to this
	12	* project.
	13	*
	14	* This program is free software; you can redistribute it and/or
	15	* modify it under the terms of the GNU General Public License as
	16	* published by the Free Software Foundation; either version 2 of
	17	* the License, or (at your option) any later version.
	18	*
	19	* This program is distributed in the hope that it will be useful,
	20	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	21	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	22	* GNU General Public License for more details.
	23	*
	24	* You should have received a copy of the GNU General Public License
	25	* along with this program; if not, write to the Free Software
	26	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	27	* MA 02111-1307 USA
	28	*/
	29
	30	/* #define DEBUG */
	31
	32	#include <common.h>
	33
	34	#if defined(CFG_ENV_IS_IN_NAND) /* Environment is in Nand Flash */
	35
	36	#include <command.h>
	37	#include <environment.h>
	38	#include <linux/stddef.h>
e443c944	39	#include <malloc.h>
addb2e16	40	#include <nand.h>
13a5695b WD	41
	42	#if ((CONFIG_COMMANDS&(CFG_CMD_ENV\|CFG_CMD_NAND)) == (CFG_CMD_ENV\|CFG_CMD_NAND))
	43	#define CMD_SAVEENV
e443c944 MK	44	#elif defined(CFG_ENV_OFFSET_REDUND)
e443c944 MK	45	#error Cannot use CFG_ENV_OFFSET_REDUND without CFG_CMD_ENV & CFG_CMD_NAND
13a5695b WD	46	#endif
13a5695b WD	47
e443c944 MK	48	#if defined(CFG_ENV_SIZE_REDUND) && (CFG_ENV_SIZE_REDUND != CFG_ENV_SIZE)
e443c944 MK	49	#error CFG_ENV_SIZE_REDUND should be the same as CFG_ENV_SIZE
13a5695b WD	50	#endif
13a5695b WD	51
13a5695b WD	52	#ifdef CONFIG_INFERNO
	53	#error CONFIG_INFERNO not supported yet
	54	#endif
	55
addb2e16	56	int nand_legacy_rw (struct nand_chip* nand, int cmd,
13a5695b WD	57	size_t start, size_t len,
13a5695b WD	58	size_t * retlen, u_char * buf);
addb2e16 BS	59
	60	/* info for NAND chips, defined in drivers/nand/nand.c */
	61	extern nand_info_t nand_info[];
13a5695b WD	62
	63	/* references to names in env_common.c */
	64	extern uchar default_environment[];
	65	extern int default_environment_size;
	66
	67	char * env_name_spec = "NAND";
	68
	69
	70	#ifdef ENV_IS_EMBEDDED
	71	extern uchar environment[];
	72	env_t env_ptr = (env_t )(&environment[0]);
	73	#else /* ! ENV_IS_EMBEDDED */
49822e23	74	env_t *env_ptr = 0;
13a5695b WD	75	#endif /* ENV_IS_EMBEDDED */
	76
	77
	78	/* local functions */
	79	static void use_default(void);
	80
d87080b7	81	DECLARE_GLOBAL_DATA_PTR;
13a5695b WD	82
	83	uchar env_get_char_spec (int index)
	84	{
13a5695b WD	85	return ( ((uchar )(gd->env_addr + index)) );
	86	}
	87
	88
	89	/* this is called before nand_init()
	90	* so we can't read Nand to validate env data.
	91	* Mark it OK for now. env_relocate() in env_common.c
	92	* will call our relocate function which will does
	93	* the real validation.
	94	*/
	95	int env_init(void)
	96	{
e443c944	97	gd->env_addr = (ulong)&default_environment[0];
13a5695b WD	98	gd->env_valid = 1;
	99
	100	return (0);
	101	}
	102
	103	#ifdef CMD_SAVEENV
addb2e16 BS	104	/*
	105	* The legacy NAND code saved the environment in the first NAND device i.e.,
	106	* nand_dev_desc + 0. This is also the behaviour using the new NAND code.
	107	*/
e443c944	108	#ifdef CFG_ENV_OFFSET_REDUND
13a5695b WD	109	int saveenv(void)
13a5695b WD	110	{
2770bcb2 MK	111	ulong total;
2770bcb2 MK	112	int ret = 0;
e443c944	113
e443c944 MK	114	env_ptr->flags++;
	115	total = CFG_ENV_SIZE;
	116
	117	if(gd->env_valid == 1) {
	118	puts ("Erasing redundant Nand...");
	119	if (nand_erase(&nand_info[0],
	120	CFG_ENV_OFFSET_REDUND, CFG_ENV_SIZE))
	121	return 1;
	122	puts ("Writing to redundant Nand... ");
	123	ret = nand_write(&nand_info[0], CFG_ENV_OFFSET_REDUND, &total,
	124	(u_char*) env_ptr);
	125	} else {
	126	puts ("Erasing Nand...");
	127	if (nand_erase(&nand_info[0],
	128	CFG_ENV_OFFSET, CFG_ENV_SIZE))
	129	return 1;
	130
	131	puts ("Writing to Nand... ");
	132	ret = nand_write(&nand_info[0], CFG_ENV_OFFSET, &total,
	133	(u_char*) env_ptr);
	134	}
	135	if (ret \|\| total != CFG_ENV_SIZE)
	136	return 1;
	137
	138	puts ("done\n");
	139	gd->env_valid = (gd->env_valid == 2 ? 1 : 2);
	140	return ret;
	141	}
	142	#else /* ! CFG_ENV_OFFSET_REDUND */
	143	int saveenv(void)
	144	{
d52fb7e3 WD	145	ulong total;
d52fb7e3 WD	146	int ret = 0;
addb2e16 BS	147
addb2e16 BS	148	puts ("Erasing Nand...");
3c4eb088	149	if (nand_erase(&nand_info[0], CFG_ENV_OFFSET, CFG_ENV_SIZE))
addb2e16	150	return 1;
13a5695b WD	151
13a5695b WD	152	puts ("Writing to Nand... ");
addb2e16	153	total = CFG_ENV_SIZE;
d52fb7e3	154	ret = nand_write(&nand_info[0], CFG_ENV_OFFSET, &total, (u_char*)env_ptr);
addb2e16	155	if (ret \|\| total != CFG_ENV_SIZE)
13a5695b WD	156	return 1;
13a5695b WD	157
addb2e16 BS	158	puts ("done\n");
addb2e16 BS	159	return ret;
13a5695b	160	}
e443c944	161	#endif /* CFG_ENV_OFFSET_REDUND */
13a5695b WD	162	#endif /* CMD_SAVEENV */
13a5695b WD	163
e443c944 MK	164	#ifdef CFG_ENV_OFFSET_REDUND
	165	void env_relocate_spec (void)
	166	{
	167	#if !defined(ENV_IS_EMBEDDED)
2770bcb2 MK	168	ulong total;
2770bcb2 MK	169	int crc1_ok = 0, crc2_ok = 0;
e443c944 MK	170	env_t tmp_env1, tmp_env2;
e443c944 MK	171
e443c944 MK	172	total = CFG_ENV_SIZE;
	173
	174	tmp_env1 = (env_t *) malloc(CFG_ENV_SIZE);
	175	tmp_env2 = (env_t *) malloc(CFG_ENV_SIZE);
	176
	177	nand_read(&nand_info[0], CFG_ENV_OFFSET, &total,
	178	(u_char*) tmp_env1);
	179	nand_read(&nand_info[0], CFG_ENV_OFFSET_REDUND, &total,
	180	(u_char*) tmp_env2);
	181
	182	crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
	183	crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
	184
	185	if(!crc1_ok && !crc2_ok)
	186	return use_default();
	187	else if(crc1_ok && !crc2_ok)
	188	gd->env_valid = 1;
	189	else if(!crc1_ok && crc2_ok)
	190	gd->env_valid = 2;
	191	else {
	192	/* both ok - check serial */
	193	if(tmp_env1->flags == 255 && tmp_env2->flags == 0)
	194	gd->env_valid = 2;
	195	else if(tmp_env2->flags == 255 && tmp_env1->flags == 0)
	196	gd->env_valid = 1;
	197	else if(tmp_env1->flags > tmp_env2->flags)
	198	gd->env_valid = 1;
	199	else if(tmp_env2->flags > tmp_env1->flags)
	200	gd->env_valid = 2;
	201	else /* flags are equal - almost impossible */
	202	gd->env_valid = 1;
13a5695b	203
e443c944 MK	204	}
	205
	206	free(env_ptr);
	207	if(gd->env_valid == 1) {
	208	env_ptr = tmp_env1;
	209	free(tmp_env2);
	210	} else {
	211	env_ptr = tmp_env2;
	212	free(tmp_env1);
	213	}
	214
	215	#endif /* ! ENV_IS_EMBEDDED */
	216	}
	217	#else /* ! CFG_ENV_OFFSET_REDUND */
addb2e16 BS	218	/*
	219	* The legacy NAND code saved the environment in the first NAND device i.e.,
	220	* nand_dev_desc + 0. This is also the behaviour using the new NAND code.
	221	*/
13a5695b WD	222	void env_relocate_spec (void)
	223	{
	224	#if !defined(ENV_IS_EMBEDDED)
d52fb7e3 WD	225	ulong total;
d52fb7e3 WD	226	int ret;
13a5695b	227
addb2e16	228	total = CFG_ENV_SIZE;
d52fb7e3	229	ret = nand_read(&nand_info[0], CFG_ENV_OFFSET, &total, (u_char*)env_ptr);
13a5695b WD	230	if (ret \|\| total != CFG_ENV_SIZE)
	231	return use_default();
	232
	233	if (crc32(0, env_ptr->data, ENV_SIZE) != env_ptr->crc)
	234	return use_default();
	235	#endif /* ! ENV_IS_EMBEDDED */
13a5695b	236	}
e443c944	237	#endif /* CFG_ENV_OFFSET_REDUND */
13a5695b WD	238
	239	static void use_default()
	240	{
13a5695b WD	241	puts ("*** Warning - bad CRC or NAND, using default environment\n\n");
13a5695b WD	242
e443c944	243	if (default_environment_size > CFG_ENV_SIZE){
13a5695b WD	244	puts ("*** Error - default environment is too large\n\n");
	245	return;
	246	}
	247
	248	memset (env_ptr, 0, sizeof(env_t));
	249	memcpy (env_ptr->data,
	250	default_environment,
	251	default_environment_size);
	252	env_ptr->crc = crc32(0, env_ptr->data, ENV_SIZE);
e443c944	253	gd->env_valid = 1;
13a5695b WD	254
	255	}
	256
	257	#endif /* CFG_ENV_IS_IN_NAND */