[thirdparty/u-boot.git] / cmd / eeprom.c

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

/*
 * 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)
{
	/* I2C EEPROM */
#if defined(CONFIG_SYS_I2C)
	if (bus >= 0)
		i2c_set_bus_num(bus);
	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;

#if defined(CONFIG_DM_I2C) && defined(CONFIG_SYS_I2C_EEPROM_BUS)
	struct udevice *dev;

	ret = i2c_get_chip_for_busnum(CONFIG_SYS_I2C_EEPROM_BUS, addr[0],
				      alen - 1, &dev);
	if (ret) {
		printf("%s: Cannot find udev for a bus %d\n", __func__,
		       CONFIG_SYS_I2C_EEPROM_BUS);
		return CMD_RET_FAILURE;
	}

	if (read)
		ret = dm_i2c_read(dev, offset, buffer, len);
	else
		ret = dm_i2c_write(dev, offset, buffer, len);

#else /* Non DM I2C support - will be removed */
#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);
#endif /* CONFIG_DM_I2C && CONFIG_SYS_I2C_EEPROM_BUS */
	if (ret)
		ret = CMD_RET_FAILURE;

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

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