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

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2000, 2001
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 */

/*
 * 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
 * Set CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS to 0
 *
 */

#include <config.h>
#include <command.h>
#include <eeprom.h>
#include <i2c.h>
#include <eeprom_layout.h>
#include <vsprintf.h>
#include <linux/delay.h>

#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))

#if CONFIG_IS_ENABLED(DM_I2C)
static int eeprom_i2c_bus;
#endif

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

void eeprom_init(int bus)
{
	/* I2C EEPROM */
#if CONFIG_IS_ENABLED(DM_I2C)
	eeprom_i2c_bus = bus;
#elif CONFIG_IS_ENABLED(SYS_I2C_LEGACY)
	if (bus >= 0)
		i2c_set_bus_num(bus);
	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
#endif
}

/*
 * 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.
 */
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 accessed 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 CONFIG_IS_ENABLED(DM_I2C)
	struct udevice *dev;

	ret = i2c_get_chip_for_busnum(eeprom_i2c_bus, addr[0],
				      alen - 1, &dev);
	if (ret) {
		printf("%s: Cannot find udev for a bus %d\n", __func__,
		       eeprom_i2c_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 (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 */
	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];

#if !CONFIG_IS_ENABLED(DM_I2C) && defined(CONFIG_SYS_I2C_EEPROM_BUS)
	eeprom_init(CONFIG_SYS_I2C_EEPROM_BUS);
#endif

	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 CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS > 0
		if (!read)
			udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS * 1000);
#endif
	}

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