[people/ms/u-boot.git] / cmd / eeprom.c

/*
 * (C) Copyright 2000, 2001
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

/*
 * Support for read and write access to EEPROM like memory devices. This
 * includes regular EEPROM as well as  FRAM (ferroelectic nonvolaile RAM).
 * FRAM devices read and write data at bus speed. In particular, there is no
 * write delay. Also, there is no limit imposed on the number of bytes that can
 * be transferred with a single read or write.
 *
 * Use the following configuration options to ensure no unneeded performance
 * degradation (typical for EEPROM) is incured for FRAM memory:
 *
 * #define CONFIG_SYS_I2C_FRAM
 * #undef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
 *
 */

#include <common.h>
#include <config.h>
#include <command.h>
#include <i2c.h>
#include <eeprom_layout.h>

#ifndef	CONFIG_SYS_I2C_SPEED
#define	CONFIG_SYS_I2C_SPEED	50000
#endif

#ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
#define CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS	0
#endif

#ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_BITS
#define CONFIG_SYS_EEPROM_PAGE_WRITE_BITS	8
#endif

#ifndef	I2C_RXTX_LEN
#define I2C_RXTX_LEN	128
#endif

#define	EEPROM_PAGE_SIZE	(1 << CONFIG_SYS_EEPROM_PAGE_WRITE_BITS)
#define	EEPROM_PAGE_OFFSET(x)	((x) & (EEPROM_PAGE_SIZE - 1))

/*
 * for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 2 (16-bit EEPROM address) offset is
 *   0x000nxxxx for EEPROM address selectors at n, offset xxxx in EEPROM.
 *
 * for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1 (8-bit EEPROM page address) offset is
 *   0x00000nxx for EEPROM address selectors and page number at n.
 */
#if !defined(CONFIG_SPI) || defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
#if !defined(CONFIG_SYS_I2C_EEPROM_ADDR_LEN) || \
	(CONFIG_SYS_I2C_EEPROM_ADDR_LEN < 1) || \
	(CONFIG_SYS_I2C_EEPROM_ADDR_LEN > 2)
#error CONFIG_SYS_I2C_EEPROM_ADDR_LEN must be 1 or 2
#endif
#endif

__weak int eeprom_write_enable(unsigned dev_addr, int state)
{
	return 0;
}

void eeprom_init(int bus)
{
	/* SPI EEPROM */
#if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
	spi_init_f();
#endif

	/* I2C EEPROM */
#if defined(CONFIG_HARD_I2C) || defined(CONFIG_SYS_I2C)
#if defined(CONFIG_SYS_I2C)
	if (bus >= 0)
		i2c_set_bus_num(bus);
#endif
	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
#endif
}

static int eeprom_addr(unsigned dev_addr, unsigned offset, uchar *addr)
{
	unsigned blk_off;
	int alen;

	blk_off = offset & 0xff;	/* block offset */
#if CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1
	addr[0] = offset >> 8;		/* block number */
	addr[1] = blk_off;		/* block offset */
	alen = 2;
#else
	addr[0] = offset >> 16;		/* block number */
	addr[1] = offset >>  8;		/* upper address octet */
	addr[2] = blk_off;		/* lower address octet */
	alen = 3;
#endif	/* CONFIG_SYS_I2C_EEPROM_ADDR_LEN */

	addr[0] |= dev_addr;		/* insert device address */

	return alen;
}

static int eeprom_len(unsigned offset, unsigned end)
{
	unsigned len = end - offset;

	/*
	 * For a FRAM device there is no limit on the number of the
	 * bytes that can be ccessed with the single read or write
	 * operation.
	 */
#if !defined(CONFIG_SYS_I2C_FRAM)
	unsigned blk_off = offset & 0xff;
	unsigned maxlen = EEPROM_PAGE_SIZE - EEPROM_PAGE_OFFSET(blk_off);

	if (maxlen > I2C_RXTX_LEN)
		maxlen = I2C_RXTX_LEN;

	if (len > maxlen)
		len = maxlen;
#endif

	return len;
}

static int eeprom_rw_block(unsigned offset, uchar *addr, unsigned alen,
			   uchar *buffer, unsigned len, bool read)
{
	int ret = 0;

	/* SPI */
#if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
	if (read)
		spi_read(addr, alen, buffer, len);
	else
		spi_write(addr, alen, buffer, len);
#else	/* I2C */

#if defined(CONFIG_SYS_I2C_EEPROM_BUS)
	i2c_set_bus_num(CONFIG_SYS_I2C_EEPROM_BUS);
#endif

	if (read)
		ret = i2c_read(addr[0], offset, alen - 1, buffer, len);
	else
		ret = i2c_write(addr[0], offset, alen - 1, buffer, len);

	if (ret)
		ret = 1;
#endif
	return ret;
}

static int eeprom_rw(unsigned dev_addr, unsigned offset, uchar *buffer,
		     unsigned cnt, bool read)
{
	unsigned end = offset + cnt;
	unsigned alen, len;
	int rcode = 0;
	uchar addr[3];

	while (offset < end) {
		alen = eeprom_addr(dev_addr, offset, addr);

		len = eeprom_len(offset, end);

		rcode = eeprom_rw_block(offset, addr, alen, buffer, len, read);

		buffer += len;
		offset += len;

		if (!read)
			udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS * 1000);
	}

	return rcode;
}

int eeprom_read(unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt)
{
	/*
	 * Read data until done or would cross a page boundary.
	 * We must write the address again when changing pages
	 * because the next page may be in a different device.
	 */
	return eeprom_rw(dev_addr, offset, buffer, cnt, 1);
}

int eeprom_write(unsigned dev_addr, unsigned offset,
		 uchar *buffer, unsigned cnt)
{
	int ret;

	eeprom_write_enable(dev_addr, 1);

	/*
	 * Write data until done or would cross a write page boundary.
	 * We must write the address again when changing pages
	 * because the address counter only increments within a page.
	 */
	ret = eeprom_rw(dev_addr, offset, buffer, cnt, 0);

	eeprom_write_enable(dev_addr, 0);
	return ret;
}

static int parse_numeric_param(char *str)
{
	char *endptr;
	int value = simple_strtol(str, &endptr, 16);

	return (*endptr != '\0') ? -1 : value;
}

/**
 * parse_i2c_bus_addr - parse the i2c bus and i2c devaddr parameters
 *
 * @i2c_bus:	address to store the i2c bus
 * @i2c_addr:	address to store the device i2c address
 * @argc:	count of command line arguments left to parse
 * @argv:	command line arguments left to parse
 * @argc_no_bus_addr:	argc value we expect to see when bus & addr aren't given
 *
 * @returns:	number of arguments parsed or CMD_RET_USAGE if error
 */
static int parse_i2c_bus_addr(int *i2c_bus, ulong *i2c_addr, int argc,
			      char * const argv[], int argc_no_bus_addr)
{
	int argc_no_bus = argc_no_bus_addr + 1;
	int argc_bus_addr = argc_no_bus_addr + 2;

#ifdef CONFIG_SYS_DEF_EEPROM_ADDR
	if (argc == argc_no_bus_addr) {
		*i2c_bus = -1;
		*i2c_addr = CONFIG_SYS_DEF_EEPROM_ADDR;

		return 0;
	}
#endif
	if (argc == argc_no_bus) {
		*i2c_bus = -1;
		*i2c_addr = parse_numeric_param(argv[0]);

		return 1;
	}

	if (argc == argc_bus_addr) {
		*i2c_bus = parse_numeric_param(argv[0]);
		*i2c_addr = parse_numeric_param(argv[1]);

		return 2;
	}

	return CMD_RET_USAGE;
}

#ifdef CONFIG_CMD_EEPROM_LAYOUT

__weak int eeprom_parse_layout_version(char *str)
{
	return LAYOUT_VERSION_UNRECOGNIZED;
}

static unsigned char eeprom_buf[CONFIG_SYS_EEPROM_SIZE];

#ifndef CONFIG_EEPROM_LAYOUT_HELP_STRING
#define CONFIG_EEPROM_LAYOUT_HELP_STRING "<not defined>"
#endif

#endif

enum eeprom_action {
	EEPROM_READ,
	EEPROM_WRITE,
	EEPROM_PRINT,
	EEPROM_UPDATE,
	EEPROM_ACTION_INVALID,
};

static enum eeprom_action parse_action(char *cmd)
{
	if (!strncmp(cmd, "read", 4))
		return EEPROM_READ;
	if (!strncmp(cmd, "write", 5))
		return EEPROM_WRITE;
#ifdef CONFIG_CMD_EEPROM_LAYOUT
	if (!strncmp(cmd, "print", 5))
		return EEPROM_PRINT;
	if (!strncmp(cmd, "update", 6))
		return EEPROM_UPDATE;
#endif

	return EEPROM_ACTION_INVALID;
}

static int eeprom_execute_command(enum eeprom_action action, int i2c_bus,
				  ulong i2c_addr, int layout_ver, char *key,
				  char *value, ulong addr, ulong off, ulong cnt)
{
	int rcode = 0;
	const char *const fmt =
		"\nEEPROM @0x%lX %s: addr %08lx  off %04lx  count %ld ... ";
#ifdef CONFIG_CMD_EEPROM_LAYOUT
	struct eeprom_layout layout;
#endif

	if (action == EEPROM_ACTION_INVALID)
		return CMD_RET_USAGE;

	eeprom_init(i2c_bus);
	if (action == EEPROM_READ) {
		printf(fmt, i2c_addr, "read", addr, off, cnt);

		rcode = eeprom_read(i2c_addr, off, (uchar *)addr, cnt);

		puts("done\n");
		return rcode;
	} else if (action == EEPROM_WRITE) {
		printf(fmt, i2c_addr, "write", addr, off, cnt);

		rcode = eeprom_write(i2c_addr, off, (uchar *)addr, cnt);

		puts("done\n");
		return rcode;
	}

#ifdef CONFIG_CMD_EEPROM_LAYOUT
	rcode = eeprom_read(i2c_addr, 0, eeprom_buf, CONFIG_SYS_EEPROM_SIZE);
	if (rcode < 0)
		return rcode;

	eeprom_layout_setup(&layout, eeprom_buf, CONFIG_SYS_EEPROM_SIZE,
			    layout_ver);

	if (action == EEPROM_PRINT) {
		layout.print(&layout);
		return 0;
	}

	layout.update(&layout, key, value);

	rcode = eeprom_write(i2c_addr, 0, layout.data, CONFIG_SYS_EEPROM_SIZE);
#endif

	return rcode;
}

#define NEXT_PARAM(argc, index)	{ (argc)--; (index)++; }
int do_eeprom(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	int layout_ver = LAYOUT_VERSION_AUTODETECT;
	enum eeprom_action action = EEPROM_ACTION_INVALID;
	int i2c_bus = -1, index = 0;
	ulong i2c_addr = -1, addr = 0, cnt = 0, off = 0;
	int ret;
	char *field_name = "";
	char *field_value = "";

	if (argc <= 1)
		return CMD_RET_USAGE;

	NEXT_PARAM(argc, index); /* Skip program name */

	action = parse_action(argv[index]);
	NEXT_PARAM(argc, index);

	if (action == EEPROM_ACTION_INVALID)
		return CMD_RET_USAGE;

#ifdef CONFIG_CMD_EEPROM_LAYOUT
	if (action == EEPROM_PRINT || action == EEPROM_UPDATE) {
		if (!strcmp(argv[index], "-l")) {
			NEXT_PARAM(argc, index);
			layout_ver = eeprom_parse_layout_version(argv[index]);
			NEXT_PARAM(argc, index);
		}
	}
#endif

	switch (action) {
	case EEPROM_READ:
	case EEPROM_WRITE:
		ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
					 argv + index, 3);
		break;
	case EEPROM_PRINT:
		ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
					 argv + index, 0);
		break;
	case EEPROM_UPDATE:
		ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
					 argv + index, 2);
		break;
	default:
		/* Get compiler to stop whining */
		return CMD_RET_USAGE;
	}

	if (ret == CMD_RET_USAGE)
		return ret;

	while (ret--)
		NEXT_PARAM(argc, index);

	if (action == EEPROM_READ || action == EEPROM_WRITE) {
		addr = parse_numeric_param(argv[index]);
		NEXT_PARAM(argc, index);
		off = parse_numeric_param(argv[index]);
		NEXT_PARAM(argc, index);
		cnt = parse_numeric_param(argv[index]);
	}

#ifdef CONFIG_CMD_EEPROM_LAYOUT
	if (action == EEPROM_UPDATE) {
		field_name = argv[index];
		NEXT_PARAM(argc, index);
		field_value = argv[index];
		NEXT_PARAM(argc, index);
	}
#endif

	return eeprom_execute_command(action, i2c_bus, i2c_addr, layout_ver,
				      field_name, field_value, addr, off, cnt);
}

U_BOOT_CMD(
	eeprom,	8,	1,	do_eeprom,
	"EEPROM sub-system",
	"read  <bus> <devaddr> addr off cnt\n"
	"eeprom write <bus> <devaddr> addr off cnt\n"
	"       - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
#ifdef CONFIG_CMD_EEPROM_LAYOUT
	"\n"
	"eeprom print [-l <layout_version>] <bus> <devaddr>\n"
	"       - Print layout fields and their data in human readable format\n"
	"eeprom update [-l <layout_version>] <bus> <devaddr> field_name field_value\n"
	"       - Update a specific eeprom field with new data.\n"
	"         The new data must be written in the same human readable format as shown by the print command.\n"
	"\n"
	"LAYOUT VERSIONS\n"
	"The -l option can be used to force the command to interpret the EEPROM data using the chosen layout.\n"
	"If the -l option is omitted, the command will auto detect the layout based on the data in the EEPROM.\n"
	"The values which can be provided with the -l option are:\n"
	CONFIG_EEPROM_LAYOUT_HELP_STRING"\n"
#endif
)
Commit	Line	Data
3863585b WD	1	/*
	2	* (C) Copyright 2000, 2001
	3	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	4	*
1a459660	5	* SPDX-License-Identifier: GPL-2.0+
3863585b WD	6	*/
3863585b WD	7
d4f5c728	8	/*
	9	* Support for read and write access to EEPROM like memory devices. This
	10	* includes regular EEPROM as well as FRAM (ferroelectic nonvolaile RAM).
	11	* FRAM devices read and write data at bus speed. In particular, there is no
e506a006	12	* write delay. Also, there is no limit imposed on the number of bytes that can
d4f5c728	13	* be transferred with a single read or write.
6617aae9	14	*
d4f5c728	15	* Use the following configuration options to ensure no unneeded performance
d4f5c728	16	* degradation (typical for EEPROM) is incured for FRAM memory:
6617aae9	17	*
6d0f6bcf JCPV	18	* #define CONFIG_SYS_I2C_FRAM
6d0f6bcf JCPV	19	* #undef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
d4f5c728	20	*
	21	*/
	22
3863585b WD	23	#include <common.h>
	24	#include <config.h>
	25	#include <command.h>
	26	#include <i2c.h>
e7c2729b	27	#include <eeprom_layout.h>
3863585b	28
4f296d09 MV	29	#ifndef CONFIG_SYS_I2C_SPEED
4f296d09 MV	30	#define CONFIG_SYS_I2C_SPEED 50000
98f4a3df	31	#endif
3863585b	32
d738746c MV	33	#ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
	34	#define CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS 0
	35	#endif
	36
6717e3c8 MV	37	#ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_BITS
	38	#define CONFIG_SYS_EEPROM_PAGE_WRITE_BITS 8
	39	#endif
	40
a6e7b774 MS	41	#ifndef I2C_RXTX_LEN
	42	#define I2C_RXTX_LEN 128
	43	#endif
	44
6717e3c8 MV	45	#define EEPROM_PAGE_SIZE (1 << CONFIG_SYS_EEPROM_PAGE_WRITE_BITS)
	46	#define EEPROM_PAGE_OFFSET(x) ((x) & (EEPROM_PAGE_SIZE - 1))
	47
4f296d09	48	/*
6d0f6bcf	49	* for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 2 (16-bit EEPROM address) offset is
3863585b WD	50	* 0x000nxxxx for EEPROM address selectors at n, offset xxxx in EEPROM.
3863585b WD	51	*
6d0f6bcf	52	* for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1 (8-bit EEPROM page address) offset is
3863585b WD	53	* 0x00000nxx for EEPROM address selectors and page number at n.
3863585b WD	54	*/
548738b4	55	#if !defined(CONFIG_SPI) \|\| defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
4f296d09	56	#if !defined(CONFIG_SYS_I2C_EEPROM_ADDR_LEN) \|\| \
d4e69e61 MV	57	(CONFIG_SYS_I2C_EEPROM_ADDR_LEN < 1) \|\| \
d4e69e61 MV	58	(CONFIG_SYS_I2C_EEPROM_ADDR_LEN > 2)
6d0f6bcf	59	#error CONFIG_SYS_I2C_EEPROM_ADDR_LEN must be 1 or 2
3863585b WD	60	#endif
	61	#endif
	62
52cd47c9 MV	63	__weak int eeprom_write_enable(unsigned dev_addr, int state)
	64	{
	65	return 0;
	66	}
4f296d09	67
354e3ed7	68	void eeprom_init(int bus)
4f296d09 MV	69	{
	70	/* SPI EEPROM */
	71	#if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
8eee40a6	72	spi_init_f();
4f296d09 MV	73	#endif
	74
	75	/* I2C EEPROM */
2636ac65	76	#if defined(CONFIG_HARD_I2C) \|\| defined(CONFIG_SYS_I2C)
354e3ed7 MV	77	#if defined(CONFIG_SYS_I2C)
	78	if (bus >= 0)
	79	i2c_set_bus_num(bus);
	80	#endif
4f296d09 MV	81	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
	82	#endif
	83	}
	84
02c321cf MV	85	static int eeprom_addr(unsigned dev_addr, unsigned offset, uchar *addr)
	86	{
	87	unsigned blk_off;
	88	int alen;
	89
	90	blk_off = offset & 0xff; /* block offset */
	91	#if CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1
	92	addr[0] = offset >> 8; /* block number */
	93	addr[1] = blk_off; /* block offset */
	94	alen = 2;
	95	#else
	96	addr[0] = offset >> 16; /* block number */
	97	addr[1] = offset >> 8; /* upper address octet */
	98	addr[2] = blk_off; /* lower address octet */
	99	alen = 3;
	100	#endif /* CONFIG_SYS_I2C_EEPROM_ADDR_LEN */
	101
	102	addr[0] \|= dev_addr; /* insert device address */
	103
	104	return alen;
	105	}
	106
39b6f98b MV	107	static int eeprom_len(unsigned offset, unsigned end)
	108	{
	109	unsigned len = end - offset;
	110
	111	/*
	112	* For a FRAM device there is no limit on the number of the
	113	* bytes that can be ccessed with the single read or write
	114	* operation.
	115	*/
	116	#if !defined(CONFIG_SYS_I2C_FRAM)
	117	unsigned blk_off = offset & 0xff;
	118	unsigned maxlen = EEPROM_PAGE_SIZE - EEPROM_PAGE_OFFSET(blk_off);
	119
	120	if (maxlen > I2C_RXTX_LEN)
	121	maxlen = I2C_RXTX_LEN;
	122
	123	if (len > maxlen)
	124	len = maxlen;
	125	#endif
	126
	127	return len;
	128	}
	129
9132088b MV	130	static int eeprom_rw_block(unsigned offset, uchar *addr, unsigned alen,
	131	uchar *buffer, unsigned len, bool read)
	132	{
	133	int ret = 0;
	134
	135	/* SPI */
	136	#if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
	137	if (read)
	138	spi_read(addr, alen, buffer, len);
	139	else
	140	spi_write(addr, alen, buffer, len);
	141	#else /* I2C */
	142
	143	#if defined(CONFIG_SYS_I2C_EEPROM_BUS)
	144	i2c_set_bus_num(CONFIG_SYS_I2C_EEPROM_BUS);
	145	#endif
	146
	147	if (read)
	148	ret = i2c_read(addr[0], offset, alen - 1, buffer, len);
	149	else
	150	ret = i2c_write(addr[0], offset, alen - 1, buffer, len);
	151
	152	if (ret)
	153	ret = 1;
	154	#endif
	155	return ret;
	156	}
	157
1a37889b MV	158	static int eeprom_rw(unsigned dev_addr, unsigned offset, uchar *buffer,
1a37889b MV	159	unsigned cnt, bool read)
3863585b WD	160	{
3863585b WD	161	unsigned end = offset + cnt;
1a37889b	162	unsigned alen, len;
3863585b	163	int rcode = 0;
02c321cf	164	uchar addr[3];
3863585b	165
3863585b	166	while (offset < end) {
02c321cf	167	alen = eeprom_addr(dev_addr, offset, addr);
3863585b	168
39b6f98b	169	len = eeprom_len(offset, end);
d4f5c728	170
1a37889b	171	rcode = eeprom_rw_block(offset, addr, alen, buffer, len, read);
9132088b	172
3863585b WD	173	buffer += len;
3863585b WD	174	offset += len;
1a37889b MV	175
	176	if (!read)
	177	udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS * 1000);
3863585b	178	}
d4f5c728	179
3863585b WD	180	return rcode;
	181	}
	182
1a37889b	183	int eeprom_read(unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt)
3863585b	184	{
1a37889b MV	185	/*
	186	* Read data until done or would cross a page boundary.
	187	* We must write the address again when changing pages
	188	* because the next page may be in a different device.
	189	*/
	190	return eeprom_rw(dev_addr, offset, buffer, cnt, 1);
	191	}
	192
d4e69e61 MV	193	int eeprom_write(unsigned dev_addr, unsigned offset,
d4e69e61 MV	194	uchar *buffer, unsigned cnt)
1a37889b MV	195	{
1a37889b MV	196	int ret;
3863585b	197
52cd47c9 MV	198	eeprom_write_enable(dev_addr, 1);
52cd47c9 MV	199
4f296d09 MV	200	/*
4f296d09 MV	201	* Write data until done or would cross a write page boundary.
3863585b WD	202	* We must write the address again when changing pages
	203	* because the address counter only increments within a page.
	204	*/
52bc7c7e	205	ret = eeprom_rw(dev_addr, offset, buffer, cnt, 0);
52cd47c9 MV	206
52cd47c9 MV	207	eeprom_write_enable(dev_addr, 0);
1a37889b	208	return ret;
3863585b WD	209	}
3863585b WD	210
c40f0372 NK	211	static int parse_numeric_param(char *str)
	212	{
	213	char *endptr;
	214	int value = simple_strtol(str, &endptr, 16);
	215
	216	return (*endptr != '\0') ? -1 : value;
	217	}
	218
	219	/**
	220	* parse_i2c_bus_addr - parse the i2c bus and i2c devaddr parameters
	221	*
	222	* @i2c_bus: address to store the i2c bus
	223	* @i2c_addr: address to store the device i2c address
	224	* @argc: count of command line arguments left to parse
	225	* @argv: command line arguments left to parse
	226	* @argc_no_bus_addr: argc value we expect to see when bus & addr aren't given
	227	*
	228	* @returns: number of arguments parsed or CMD_RET_USAGE if error
	229	*/
	230	static int parse_i2c_bus_addr(int i2c_bus, ulong i2c_addr, int argc,
	231	char * const argv[], int argc_no_bus_addr)
	232	{
	233	int argc_no_bus = argc_no_bus_addr + 1;
	234	int argc_bus_addr = argc_no_bus_addr + 2;
	235
	236	#ifdef CONFIG_SYS_DEF_EEPROM_ADDR
	237	if (argc == argc_no_bus_addr) {
	238	*i2c_bus = -1;
	239	*i2c_addr = CONFIG_SYS_DEF_EEPROM_ADDR;
	240
	241	return 0;
	242	}
	243	#endif
	244	if (argc == argc_no_bus) {
	245	*i2c_bus = -1;
	246	*i2c_addr = parse_numeric_param(argv[0]);
	247
	248	return 1;
	249	}
	250
	251	if (argc == argc_bus_addr) {
	252	*i2c_bus = parse_numeric_param(argv[0]);
	253	*i2c_addr = parse_numeric_param(argv[1]);
	254
	255	return 2;
	256	}
	257
	258	return CMD_RET_USAGE;
	259	}
	260
aa9e6044	261	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044 NK	262
	263	__weak int eeprom_parse_layout_version(char *str)
	264	{
	265	return LAYOUT_VERSION_UNRECOGNIZED;
	266	}
	267
	268	static unsigned char eeprom_buf[CONFIG_SYS_EEPROM_SIZE];
	269
	270	#ifndef CONFIG_EEPROM_LAYOUT_HELP_STRING
	271	#define CONFIG_EEPROM_LAYOUT_HELP_STRING "<not defined>"
	272	#endif
	273
e7c2729b NK	274	#endif
e7c2729b NK	275
aa9e6044	276	enum eeprom_action {
e7c2729b NK	277	EEPROM_READ,
e7c2729b NK	278	EEPROM_WRITE,
aa9e6044 NK	279	EEPROM_PRINT,
	280	EEPROM_UPDATE,
	281	EEPROM_ACTION_INVALID,
	282	};
	283
	284	static enum eeprom_action parse_action(char *cmd)
	285	{
3dc9be82 NK	286	if (!strncmp(cmd, "read", 4))
	287	return EEPROM_READ;
	288	if (!strncmp(cmd, "write", 5))
	289	return EEPROM_WRITE;
	290	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044 NK	291	if (!strncmp(cmd, "print", 5))
	292	return EEPROM_PRINT;
	293	if (!strncmp(cmd, "update", 6))
	294	return EEPROM_UPDATE;
3dc9be82	295	#endif
aa9e6044 NK	296
	297	return EEPROM_ACTION_INVALID;
	298	}
	299
aa9e6044	300	static int eeprom_execute_command(enum eeprom_action action, int i2c_bus,
e7c2729b NK	301	ulong i2c_addr, int layout_ver, char *key,
e7c2729b NK	302	char *value, ulong addr, ulong off, ulong cnt)
aa9e6044	303	{
e7c2729b NK	304	int rcode = 0;
	305	const char *const fmt =
	306	"\nEEPROM @0x%lX %s: addr %08lx off %04lx count %ld ... ";
	307	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044	308	struct eeprom_layout layout;
e7c2729b	309	#endif
aa9e6044 NK	310
	311	if (action == EEPROM_ACTION_INVALID)
	312	return CMD_RET_USAGE;
	313
	314	eeprom_init(i2c_bus);
e7c2729b NK	315	if (action == EEPROM_READ) {
	316	printf(fmt, i2c_addr, "read", addr, off, cnt);
	317
	318	rcode = eeprom_read(i2c_addr, off, (uchar *)addr, cnt);
	319
	320	puts("done\n");
	321	return rcode;
	322	} else if (action == EEPROM_WRITE) {
	323	printf(fmt, i2c_addr, "write", addr, off, cnt);
	324
	325	rcode = eeprom_write(i2c_addr, off, (uchar *)addr, cnt);
	326
	327	puts("done\n");
	328	return rcode;
	329	}
	330
	331	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044 NK	332	rcode = eeprom_read(i2c_addr, 0, eeprom_buf, CONFIG_SYS_EEPROM_SIZE);
	333	if (rcode < 0)
	334	return rcode;
	335
	336	eeprom_layout_setup(&layout, eeprom_buf, CONFIG_SYS_EEPROM_SIZE,
	337	layout_ver);
	338
	339	if (action == EEPROM_PRINT) {
	340	layout.print(&layout);
	341	return 0;
	342	}
	343
	344	layout.update(&layout, key, value);
	345
	346	rcode = eeprom_write(i2c_addr, 0, layout.data, CONFIG_SYS_EEPROM_SIZE);
e7c2729b	347	#endif
aa9e6044 NK	348
	349	return rcode;
	350	}
	351
	352	#define NEXT_PARAM(argc, index) { (argc)--; (index)++; }
3dc9be82	353	int do_eeprom(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
aa9e6044 NK	354	{
	355	int layout_ver = LAYOUT_VERSION_AUTODETECT;
	356	enum eeprom_action action = EEPROM_ACTION_INVALID;
3dc9be82 NK	357	int i2c_bus = -1, index = 0;
	358	ulong i2c_addr = -1, addr = 0, cnt = 0, off = 0;
	359	int ret;
aa9e6044 NK	360	char *field_name = "";
	361	char *field_value = "";
	362
	363	if (argc <= 1)
	364	return CMD_RET_USAGE;
	365
	366	NEXT_PARAM(argc, index); /* Skip program name */
	367
	368	action = parse_action(argv[index]);
	369	NEXT_PARAM(argc, index);
	370
3dc9be82	371	if (action == EEPROM_ACTION_INVALID)
aa9e6044 NK	372	return CMD_RET_USAGE;
aa9e6044 NK	373
3dc9be82 NK	374	#ifdef CONFIG_CMD_EEPROM_LAYOUT
	375	if (action == EEPROM_PRINT \|\| action == EEPROM_UPDATE) {
	376	if (!strcmp(argv[index], "-l")) {
	377	NEXT_PARAM(argc, index);
	378	layout_ver = eeprom_parse_layout_version(argv[index]);
	379	NEXT_PARAM(argc, index);
	380	}
aa9e6044	381	}
3dc9be82	382	#endif
aa9e6044	383
3dc9be82 NK	384	switch (action) {
	385	case EEPROM_READ:
	386	case EEPROM_WRITE:
	387	ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
	388	argv + index, 3);
	389	break;
	390	case EEPROM_PRINT:
	391	ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
	392	argv + index, 0);
	393	break;
	394	case EEPROM_UPDATE:
	395	ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
	396	argv + index, 2);
	397	break;
	398	default:
	399	/* Get compiler to stop whining */
aa9e6044	400	return CMD_RET_USAGE;
3dc9be82	401	}
aa9e6044	402
3dc9be82 NK	403	if (ret == CMD_RET_USAGE)
3dc9be82 NK	404	return ret;
aa9e6044	405
3dc9be82	406	while (ret--)
aa9e6044	407	NEXT_PARAM(argc, index);
aa9e6044	408
3dc9be82 NK	409	if (action == EEPROM_READ \|\| action == EEPROM_WRITE) {
	410	addr = parse_numeric_param(argv[index]);
	411	NEXT_PARAM(argc, index);
	412	off = parse_numeric_param(argv[index]);
aa9e6044	413	NEXT_PARAM(argc, index);
3dc9be82	414	cnt = parse_numeric_param(argv[index]);
aa9e6044 NK	415	}
aa9e6044 NK	416
aa9e6044	417	#ifdef CONFIG_CMD_EEPROM_LAYOUT
3dc9be82 NK	418	if (action == EEPROM_UPDATE) {
	419	field_name = argv[index];
	420	NEXT_PARAM(argc, index);
	421	field_value = argv[index];
	422	NEXT_PARAM(argc, index);
aa9e6044 NK	423	}
	424	#endif
	425
3dc9be82 NK	426	return eeprom_execute_command(action, i2c_bus, i2c_addr, layout_ver,
3dc9be82 NK	427	field_name, field_value, addr, off, cnt);
4f296d09	428	}
8bde7f77	429
0d498393	430	U_BOOT_CMD(
aa9e6044	431	eeprom, 8, 1, do_eeprom,
2fb2604d	432	"EEPROM sub-system",
d4fec4e9 MV	433	"read <bus> <devaddr> addr off cnt\n"
d4fec4e9 MV	434	"eeprom write <bus> <devaddr> addr off cnt\n"
a89c33db	435	" - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
aa9e6044 NK	436	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044 NK	437	"\n"
3dc9be82	438	"eeprom print [-l <layout_version>] <bus> <devaddr>\n"
aa9e6044	439	" - Print layout fields and their data in human readable format\n"
3dc9be82	440	"eeprom update [-l <layout_version>] <bus> <devaddr> field_name field_value\n"
aa9e6044 NK	441	" - Update a specific eeprom field with new data.\n"
	442	" The new data must be written in the same human readable format as shown by the print command.\n"
	443	"\n"
	444	"LAYOUT VERSIONS\n"
	445	"The -l option can be used to force the command to interpret the EEPROM data using the chosen layout.\n"
	446	"If the -l option is omitted, the command will auto detect the layout based on the data in the EEPROM.\n"
	447	"The values which can be provided with the -l option are:\n"
	448	CONFIG_EEPROM_LAYOUT_HELP_STRING"\n"
	449	#endif
0e350f81	450	)