[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 <eeprom.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

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