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

/*
 * (C) Copyright 2000-2010
 * 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
 */

#include <common.h>
#include <command.h>
#include <environment.h>
#include <linux/stddef.h>
#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
#include <i2c.h>
#endif
#include <search.h>
#include <errno.h>
#include <linux/compiler.h>	/* for BUG_ON */

DECLARE_GLOBAL_DATA_PTR;

env_t *env_ptr = NULL;

char *env_name_spec = "EEPROM";
int env_eeprom_bus = -1;

static int eeprom_bus_read(unsigned dev_addr, unsigned offset,
	uchar *buffer, unsigned cnt)
{
	int rcode;
#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	int old_bus = i2c_get_bus_num();

	if (gd->flags & GD_FLG_RELOC) {
		if (env_eeprom_bus == -1) {
			I2C_MUX_DEVICE *dev = NULL;
			dev = i2c_mux_ident_muxstring(
				(uchar *)CONFIG_I2C_ENV_EEPROM_BUS);
			if (dev != NULL)
				env_eeprom_bus = dev->busid;
			else
				printf ("error adding env eeprom bus.\n");
		}
		if (old_bus != env_eeprom_bus) {
			i2c_set_bus_num(env_eeprom_bus);
			old_bus = env_eeprom_bus;
		}
	} else {
		rcode = i2c_mux_ident_muxstring_f(
				(uchar *)CONFIG_I2C_ENV_EEPROM_BUS);
	}
#endif

	rcode = eeprom_read (dev_addr, offset, buffer, cnt);

#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	if (old_bus != env_eeprom_bus)
		i2c_set_bus_num(old_bus);
#endif
	return rcode;
}

static int eeprom_bus_write(unsigned dev_addr, unsigned offset,
	uchar *buffer, unsigned cnt)
{
	int rcode;
#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	int old_bus = i2c_get_bus_num();

	rcode = i2c_mux_ident_muxstring_f((uchar *)CONFIG_I2C_ENV_EEPROM_BUS);
#endif
	rcode = eeprom_write(dev_addr, offset, buffer, cnt);
#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	i2c_set_bus_num(old_bus);
#endif
	return rcode;
}

uchar env_get_char_spec (int index)
{
	uchar c;
	unsigned int off;
	off = CONFIG_ENV_OFFSET;

#ifdef CONFIG_ENV_OFFSET_REDUND
	if (gd->env_valid == 2)
		off = CONFIG_ENV_OFFSET_REDUND;
#endif
	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
		     off + index + offsetof(env_t,data),
		     &c, 1);

	return (c);
}

void env_relocate_spec (void)
{
	char buf[CONFIG_ENV_SIZE];
	unsigned int off = CONFIG_ENV_OFFSET;

#ifdef CONFIG_ENV_OFFSET_REDUND
	if (gd->env_valid == 2)
		off = CONFIG_ENV_OFFSET_REDUND;
#endif
	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
		     off,
		     (uchar *)buf,
		     CONFIG_ENV_SIZE);

	env_import(buf, 1);
}

int saveenv(void)
{
	env_t	env_new;
	ssize_t	len;
	char	*res;
	int rc;
	unsigned int off = CONFIG_ENV_OFFSET;
#ifdef CONFIG_ENV_OFFSET_REDUND
	unsigned int off_red = CONFIG_ENV_OFFSET_REDUND;
	char flag_obsolete = OBSOLETE_FLAG;
#endif

	BUG_ON(env_ptr != NULL);

	res = (char *)&env_new.data;
	len = hexport('\0', &res, ENV_SIZE);
	if (len < 0) {
		error("Cannot export environment: errno = %d\n", errno);
		return 1;
	}
	env_new.crc = crc32(0, env_new.data, ENV_SIZE);

#ifdef CONFIG_ENV_OFFSET_REDUND
	if (gd->env_valid == 1) {
		off = CONFIG_ENV_OFFSET_REDUND;
		off_red = CONFIG_ENV_OFFSET;
	}

	env_new.flags = ACTIVE_FLAG;
#endif

	rc = eeprom_bus_write(CONFIG_SYS_DEF_EEPROM_ADDR,
			     off,
			     (uchar *)&env_new,
			     CONFIG_ENV_SIZE);

#ifdef CONFIG_ENV_OFFSET_REDUND
	if (rc == 0) {
		eeprom_bus_write(CONFIG_SYS_DEF_EEPROM_ADDR,
				  off_red + offsetof(env_t,flags),
				  (uchar *)&flag_obsolete,
				  1);
		if (gd->env_valid == 1)
			gd->env_valid = 2;
		else
			gd->env_valid = 1;

	}
#endif

	return rc;
}

/*
 * Initialize Environment use
 *
 * We are still running from ROM, so data use is limited.
 * Use a (moderately small) buffer on the stack
 */

#ifdef CONFIG_ENV_OFFSET_REDUND
int env_init(void)
{
	ulong len;
	ulong crc[2], crc_tmp;
	unsigned int off, off_env[2];
	uchar buf[64];
	int crc_ok[2] = {0,0};
	unsigned char flags[2];
	int i;

	eeprom_init();	/* prepare for EEPROM read/write */

	off_env[0] = CONFIG_ENV_OFFSET;
	off_env[1] = CONFIG_ENV_OFFSET_REDUND;

	for (i = 0; i < 2; i++) {
		/* read CRC */
		eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
			off_env[i] + offsetof(env_t,crc),
			(uchar *)&crc[i], sizeof(ulong));
		/* read FLAGS */
		eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
			off_env[i] + offsetof(env_t,flags),
			(uchar *)&flags[i], sizeof(uchar));

		crc_tmp = 0;
		len = ENV_SIZE;
		off = off_env[i] + offsetof(env_t,data);
		while (len > 0) {
			int n = (len > sizeof(buf)) ? sizeof(buf) : len;

			eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR, off,
				buf, n);

			crc_tmp = crc32(crc_tmp, buf, n);
			len -= n;
			off += n;
		}
		if (crc_tmp == crc[i])
			crc_ok[i] = 1;
	}

	if (!crc_ok[0] && !crc_ok[1]) {
		gd->env_addr  = 0;
		gd->env_valid = 0;

		return 0;
	} else if (crc_ok[0] && !crc_ok[1]) {
		gd->env_valid = 1;
	}
	else if (!crc_ok[0] && crc_ok[1]) {
		gd->env_valid = 2;
	} else {
		/* both ok - check serial */
		if (flags[0] == ACTIVE_FLAG && flags[1] == OBSOLETE_FLAG)
			gd->env_valid = 1;
		else if (flags[0] == OBSOLETE_FLAG && flags[1] == ACTIVE_FLAG)
			gd->env_valid = 2;
		else if (flags[0] == 0xFF && flags[1] == 0)
			gd->env_valid = 2;
		else if(flags[1] == 0xFF && flags[0] == 0)
			gd->env_valid = 1;
		else /* flags are equal - almost impossible */
			gd->env_valid = 1;
	}

	if (gd->env_valid == 2)
		gd->env_addr = off_env[1] + offsetof(env_t,data);
	else if (gd->env_valid == 1)
		gd->env_addr = off_env[0] + offsetof(env_t,data);

	return (0);
}
#else
int env_init(void)
{
	ulong crc, len, new;
	unsigned off;
	uchar buf[64];

	eeprom_init();	/* prepare for EEPROM read/write */

	/* read old CRC */
	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
		     CONFIG_ENV_OFFSET+offsetof(env_t,crc),
		     (uchar *)&crc, sizeof(ulong));

	new = 0;
	len = ENV_SIZE;
	off = offsetof(env_t,data);

	while (len > 0) {
		int n = (len > sizeof(buf)) ? sizeof(buf) : len;

		eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
				CONFIG_ENV_OFFSET + off, buf, n);
		new = crc32(new, buf, n);
		len -= n;
		off += n;
	}

	if (crc == new) {
		gd->env_addr  = offsetof(env_t,data);
		gd->env_valid = 1;
	} else {
		gd->env_addr  = 0;
		gd->env_valid = 0;
	}

	return (0);
}
#endif
Commit	Line	Data
0bc4a1ac	1	/*
ea882baf	2	* (C) Copyright 2000-2010
0bc4a1ac WD	3	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	4	*
	5	* (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
	6	* Andreas Heppel <aheppel@sysgo.de>
ea882baf	7	*
0bc4a1ac WD	8	* See file CREDITS for list of people who contributed to this
	9	* project.
	10	*
	11	* This program is free software; you can redistribute it and/or
	12	* modify it under the terms of the GNU General Public License as
	13	* published by the Free Software Foundation; either version 2 of
	14	* the License, or (at your option) any later version.
	15	*
	16	* This program is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	19	* GNU General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	24	* MA 02111-1307 USA
	25	*/
	26
	27	#include <common.h>
0bc4a1ac WD	28	#include <command.h>
0bc4a1ac WD	29	#include <environment.h>
0bc4a1ac	30	#include <linux/stddef.h>
548738b4 HS	31	#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	32	#include <i2c.h>
	33	#endif
ea882baf WD	34	#include <search.h>
	35	#include <errno.h>
	36	#include <linux/compiler.h> /* for BUG_ON */
0bc4a1ac	37
d87080b7 WD	38	DECLARE_GLOBAL_DATA_PTR;
d87080b7 WD	39
0bc4a1ac WD	40	env_t *env_ptr = NULL;
0bc4a1ac WD	41
ea882baf	42	char *env_name_spec = "EEPROM";
548738b4 HS	43	int env_eeprom_bus = -1;
548738b4 HS	44
ea882baf WD	45	static int eeprom_bus_read(unsigned dev_addr, unsigned offset,
ea882baf WD	46	uchar *buffer, unsigned cnt)
548738b4 HS	47	{
	48	int rcode;
	49	#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	50	int old_bus = i2c_get_bus_num();
	51
	52	if (gd->flags & GD_FLG_RELOC) {
	53	if (env_eeprom_bus == -1) {
	54	I2C_MUX_DEVICE *dev = NULL;
	55	dev = i2c_mux_ident_muxstring(
	56	(uchar *)CONFIG_I2C_ENV_EEPROM_BUS);
ea882baf	57	if (dev != NULL)
548738b4	58	env_eeprom_bus = dev->busid;
ea882baf	59	else
548738b4 HS	60	printf ("error adding env eeprom bus.\n");
	61	}
	62	if (old_bus != env_eeprom_bus) {
	63	i2c_set_bus_num(env_eeprom_bus);
	64	old_bus = env_eeprom_bus;
	65	}
	66	} else {
	67	rcode = i2c_mux_ident_muxstring_f(
	68	(uchar *)CONFIG_I2C_ENV_EEPROM_BUS);
	69	}
	70	#endif
	71
	72	rcode = eeprom_read (dev_addr, offset, buffer, cnt);
ea882baf	73
548738b4 HS	74	#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	75	if (old_bus != env_eeprom_bus)
	76	i2c_set_bus_num(old_bus);
	77	#endif
	78	return rcode;
	79	}
	80
ea882baf WD	81	static int eeprom_bus_write(unsigned dev_addr, unsigned offset,
ea882baf WD	82	uchar *buffer, unsigned cnt)
548738b4 HS	83	{
	84	int rcode;
	85	#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	86	int old_bus = i2c_get_bus_num();
	87
	88	rcode = i2c_mux_ident_muxstring_f((uchar *)CONFIG_I2C_ENV_EEPROM_BUS);
	89	#endif
ea882baf	90	rcode = eeprom_write(dev_addr, offset, buffer, cnt);
548738b4 HS	91	#if defined(CONFIG_I2C_ENV_EEPROM_BUS)
	92	i2c_set_bus_num(old_bus);
	93	#endif
	94	return rcode;
	95	}
0bc4a1ac	96
0bc4a1ac WD	97	uchar env_get_char_spec (int index)
	98	{
	99	uchar c;
1567b596 HS	100	unsigned int off;
1567b596 HS	101	off = CONFIG_ENV_OFFSET;
ea882baf	102
1567b596 HS	103	#ifdef CONFIG_ENV_OFFSET_REDUND
	104	if (gd->env_valid == 2)
	105	off = CONFIG_ENV_OFFSET_REDUND;
	106	#endif
ea882baf	107	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
1567b596	108	off + index + offsetof(env_t,data),
0bc4a1ac WD	109	&c, 1);
	110
	111	return (c);
	112	}
	113
	114	void env_relocate_spec (void)
	115	{
ea882baf	116	char buf[CONFIG_ENV_SIZE];
1567b596	117	unsigned int off = CONFIG_ENV_OFFSET;
ea882baf	118
1567b596 HS	119	#ifdef CONFIG_ENV_OFFSET_REDUND
	120	if (gd->env_valid == 2)
	121	off = CONFIG_ENV_OFFSET_REDUND;
	122	#endif
ea882baf	123	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
1567b596	124	off,
ea882baf	125	(uchar *)buf,
0e8d1586	126	CONFIG_ENV_SIZE);
ea882baf WD	127
ea882baf WD	128	env_import(buf, 1);
0bc4a1ac WD	129	}
	130
	131	int saveenv(void)
	132	{
ea882baf WD	133	env_t env_new;
	134	ssize_t len;
	135	char *res;
1567b596 HS	136	int rc;
	137	unsigned int off = CONFIG_ENV_OFFSET;
	138	#ifdef CONFIG_ENV_OFFSET_REDUND
	139	unsigned int off_red = CONFIG_ENV_OFFSET_REDUND;
	140	char flag_obsolete = OBSOLETE_FLAG;
ea882baf WD	141	#endif
	142
	143	BUG_ON(env_ptr != NULL);
	144
	145	res = (char *)&env_new.data;
	146	len = hexport('\0', &res, ENV_SIZE);
	147	if (len < 0) {
	148	error("Cannot export environment: errno = %d\n", errno);
	149	return 1;
	150	}
	151	env_new.crc = crc32(0, env_new.data, ENV_SIZE);
	152
	153	#ifdef CONFIG_ENV_OFFSET_REDUND
1567b596 HS	154	if (gd->env_valid == 1) {
	155	off = CONFIG_ENV_OFFSET_REDUND;
	156	off_red = CONFIG_ENV_OFFSET;
	157	}
	158
ea882baf	159	env_new.flags = ACTIVE_FLAG;
1567b596 HS	160	#endif
1567b596 HS	161
ea882baf	162	rc = eeprom_bus_write(CONFIG_SYS_DEF_EEPROM_ADDR,
1567b596	163	off,
ea882baf	164	(uchar *)&env_new,
0e8d1586	165	CONFIG_ENV_SIZE);
1567b596 HS	166
	167	#ifdef CONFIG_ENV_OFFSET_REDUND
	168	if (rc == 0) {
ea882baf	169	eeprom_bus_write(CONFIG_SYS_DEF_EEPROM_ADDR,
1567b596 HS	170	off_red + offsetof(env_t,flags),
	171	(uchar *)&flag_obsolete,
	172	1);
	173	if (gd->env_valid == 1)
	174	gd->env_valid = 2;
	175	else
	176	gd->env_valid = 1;
	177
	178	}
	179	#endif
	180
	181	return rc;
0bc4a1ac WD	182	}
0bc4a1ac WD	183
ea882baf	184	/*
0bc4a1ac WD	185	* Initialize Environment use
0bc4a1ac WD	186	*
ea882baf	187	* We are still running from ROM, so data use is limited.
0bc4a1ac WD	188	* Use a (moderately small) buffer on the stack
0bc4a1ac WD	189	*/
1567b596 HS	190
	191	#ifdef CONFIG_ENV_OFFSET_REDUND
	192	int env_init(void)
	193	{
	194	ulong len;
	195	ulong crc[2], crc_tmp;
	196	unsigned int off, off_env[2];
	197	uchar buf[64];
	198	int crc_ok[2] = {0,0};
	199	unsigned char flags[2];
	200	int i;
	201
ea882baf	202	eeprom_init(); /* prepare for EEPROM read/write */
1567b596 HS	203
	204	off_env[0] = CONFIG_ENV_OFFSET;
	205	off_env[1] = CONFIG_ENV_OFFSET_REDUND;
	206
	207	for (i = 0; i < 2; i++) {
	208	/* read CRC */
ea882baf	209	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
1567b596 HS	210	off_env[i] + offsetof(env_t,crc),
	211	(uchar *)&crc[i], sizeof(ulong));
	212	/* read FLAGS */
ea882baf	213	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
1567b596 HS	214	off_env[i] + offsetof(env_t,flags),
	215	(uchar *)&flags[i], sizeof(uchar));
	216
ea882baf	217	crc_tmp = 0;
1567b596 HS	218	len = ENV_SIZE;
	219	off = off_env[i] + offsetof(env_t,data);
	220	while (len > 0) {
	221	int n = (len > sizeof(buf)) ? sizeof(buf) : len;
	222
ea882baf	223	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR, off,
1567b596 HS	224	buf, n);
1567b596 HS	225
ea882baf	226	crc_tmp = crc32(crc_tmp, buf, n);
1567b596 HS	227	len -= n;
	228	off += n;
	229	}
	230	if (crc_tmp == crc[i])
	231	crc_ok[i] = 1;
	232	}
	233
	234	if (!crc_ok[0] && !crc_ok[1]) {
	235	gd->env_addr = 0;
	236	gd->env_valid = 0;
	237
	238	return 0;
	239	} else if (crc_ok[0] && !crc_ok[1]) {
	240	gd->env_valid = 1;
	241	}
	242	else if (!crc_ok[0] && crc_ok[1]) {
	243	gd->env_valid = 2;
	244	} else {
	245	/* both ok - check serial */
	246	if (flags[0] == ACTIVE_FLAG && flags[1] == OBSOLETE_FLAG)
	247	gd->env_valid = 1;
	248	else if (flags[0] == OBSOLETE_FLAG && flags[1] == ACTIVE_FLAG)
	249	gd->env_valid = 2;
	250	else if (flags[0] == 0xFF && flags[1] == 0)
	251	gd->env_valid = 2;
	252	else if(flags[1] == 0xFF && flags[0] == 0)
	253	gd->env_valid = 1;
	254	else /* flags are equal - almost impossible */
	255	gd->env_valid = 1;
	256	}
	257
	258	if (gd->env_valid == 2)
	259	gd->env_addr = off_env[1] + offsetof(env_t,data);
	260	else if (gd->env_valid == 1)
	261	gd->env_addr = off_env[0] + offsetof(env_t,data);
	262
	263	return (0);
	264	}
	265	#else
0bc4a1ac WD	266	int env_init(void)
0bc4a1ac WD	267	{
0bc4a1ac WD	268	ulong crc, len, new;
	269	unsigned off;
	270	uchar buf[64];
	271
ea882baf	272	eeprom_init(); /* prepare for EEPROM read/write */
0bc4a1ac WD	273
0bc4a1ac WD	274	/* read old CRC */
ea882baf	275	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
0e8d1586	276	CONFIG_ENV_OFFSET+offsetof(env_t,crc),
0bc4a1ac WD	277	(uchar *)&crc, sizeof(ulong));
	278
	279	new = 0;
	280	len = ENV_SIZE;
	281	off = offsetof(env_t,data);
ea882baf	282
0bc4a1ac WD	283	while (len > 0) {
	284	int n = (len > sizeof(buf)) ? sizeof(buf) : len;
	285
ea882baf	286	eeprom_bus_read(CONFIG_SYS_DEF_EEPROM_ADDR,
548738b4	287	CONFIG_ENV_OFFSET + off, buf, n);
ea882baf	288	new = crc32(new, buf, n);
0bc4a1ac WD	289	len -= n;
	290	off += n;
	291	}
	292
	293	if (crc == new) {
	294	gd->env_addr = offsetof(env_t,data);
	295	gd->env_valid = 1;
	296	} else {
	297	gd->env_addr = 0;
	298	gd->env_valid = 0;
	299	}
	300
	301	return (0);
	302	}
1567b596	303	#endif