[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 <dm.h>
#include <eeprom.h>
#include <i2c.h>
#include <i2c_eeprom.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;
}

struct eeprom_dev_spec {
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	struct udevice *dev;
#endif
	int i2c_bus;
	ulong i2c_addr;
};

static void eeprom_dev_spec_init(struct eeprom_dev_spec *dev)
{
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	if (!dev->dev)
#endif
		eeprom_init(dev->i2c_bus);
}

static int eeprom_dev_spec_read(struct eeprom_dev_spec *dev,
				unsigned offset, uchar *buffer, unsigned cnt)
{
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	if (dev->dev)
		return i2c_eeprom_read(dev->dev, offset, buffer, cnt);
#endif
	return eeprom_read(dev->i2c_addr, offset, buffer, cnt);
}

static int eeprom_dev_spec_write(struct eeprom_dev_spec *dev,
				 unsigned offset, uchar *buffer, unsigned cnt)
{
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	if (dev->dev)
		return i2c_eeprom_write(dev->dev, offset, buffer, cnt);
#endif
	return eeprom_write(dev->i2c_addr, offset, buffer, cnt);
}

/**
 * parse_eeprom_dev_spec - parse the eeprom device specifier
 *
 * @dev:	pointer to eeprom device specifier
 * @argc:	count of command line arguments that can be used to parse
 *		the device specifier
 * @argv:	command line arguments left to parse
 *
 * @returns:	number of arguments parsed or CMD_RET_USAGE if error
 */
static int parse_eeprom_dev_spec(struct eeprom_dev_spec *dev, int argc,
				 char *const argv[])
{
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	if (argc == 0) {
		if (!uclass_first_device_err(UCLASS_I2C_EEPROM, &dev->dev))
			return 0;
	}

	if (argc == 1) {
		if (!uclass_get_device_by_name(UCLASS_I2C_EEPROM, argv[0],
					       &dev->dev))
			return 1;

		/*
		 * If we could not find the device by name and the parameter is
		 * not numeric (and so won't be handled later), fail.
		 */
		if (parse_numeric_param(argv[0]) == -1) {
			printf("Can't get eeprom device: %s\n", argv[0]);
			return CMD_RET_USAGE;
		}
	}
#endif

#ifdef CONFIG_SYS_I2C_EEPROM_ADDR
	if (argc == 0) {
		dev->i2c_bus = -1;
		dev->i2c_addr = CONFIG_SYS_I2C_EEPROM_ADDR;

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

		return 1;
	}

	if (argc == 2) {
		dev->i2c_bus = parse_numeric_param(argv[0]);
		dev->i2c_addr = parse_numeric_param(argv[1]);

		return 2;
	}

	return CMD_RET_USAGE;
}

#ifdef CONFIG_CMD_EEPROM_LAYOUT

#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
__weak int eeprom_parse_layout_version(char *str)
{
	return LAYOUT_VERSION_UNRECOGNIZED;
}
#endif

static unsigned char eeprom_buf[CONFIG_SYS_EEPROM_SIZE];

#endif

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

static enum eeprom_action parse_action(char *cmd)
{
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	if (!strncmp(cmd, "list", 4))
		return EEPROM_LIST;
#endif
	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;
}

#if CONFIG_IS_ENABLED(I2C_EEPROM)
static int do_eeprom_list(void)
{
	struct udevice *dev;
	struct uclass *uc;
	int err;

	err = uclass_get(UCLASS_I2C_EEPROM, &uc);
	if (err)
		return CMD_RET_FAILURE;

	uclass_foreach_dev(dev, uc)
		printf("%s (%s)\n", dev->name, dev->driver->name);

	return CMD_RET_SUCCESS;
}
#endif

static int do_eeprom_rw(struct eeprom_dev_spec *dev, bool read,
			ulong addr, ulong off, ulong cnt)
{
	const char *const fmt =
		"\nEEPROM @0x%lX %s: addr 0x%08lx  off 0x%04lx  count %ld ... ";
	uchar *memloc = (uchar *)addr;
	int ret;

	printf(fmt, dev->i2c_addr, read ? "read" : "write", addr, off, cnt);
	if (read)
		ret = eeprom_dev_spec_read(dev, off, memloc, cnt);
	else
		ret = eeprom_dev_spec_write(dev, off, memloc, cnt);
	puts("done\n");

	return ret;
}

#ifdef CONFIG_CMD_EEPROM_LAYOUT

static int do_eeprom_layout(struct eeprom_dev_spec *dev, int layout_ver,
			    struct eeprom_layout *layout)
{
	eeprom_layout_setup(layout, eeprom_buf, CONFIG_SYS_EEPROM_SIZE,
			    layout_ver);

	return eeprom_dev_spec_read(dev, 0, eeprom_buf, layout->data_size);
}

static int do_eeprom_print(struct eeprom_dev_spec *dev, int layout_ver)
{
	struct eeprom_layout layout;
	int ret;

	ret = do_eeprom_layout(dev, layout_ver, &layout);
	if (ret)
		return ret;

	layout.print(&layout);

	return 0;
}

static int do_eeprom_update(struct eeprom_dev_spec *dev, int layout_ver,
			    char *key, char *value)
{
	struct eeprom_layout layout;
	int ret;

	ret = do_eeprom_layout(dev, layout_ver, &layout);
	if (ret)
		return ret;

	ret = layout.update(&layout, key, value);
	if (ret)
		return CMD_RET_FAILURE;

	return eeprom_dev_spec_write(dev, 0, layout.data, layout.data_size);
}

#endif

static int eeprom_action_expected_argc(enum eeprom_action action)
{
	switch (action) {
	case EEPROM_LIST:
		return 0;
	case EEPROM_READ:
	case EEPROM_WRITE:
		return 3;
	case EEPROM_PRINT:
		return 0;
	case EEPROM_UPDATE:
		return 2;
	default:
		return CMD_RET_USAGE;
	}
}

#define NEXT_PARAM(argc, index)	{ (argc)--; (index)++; }
int do_eeprom(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
	enum eeprom_action action = EEPROM_ACTION_INVALID;
	struct eeprom_dev_spec dev;
	ulong addr = 0, cnt = 0, off = 0;
	int ret, index = 0;
#ifdef CONFIG_CMD_EEPROM_LAYOUT
	char *field_name = "";
	char *field_value = "";
	int layout_ver = LAYOUT_VERSION_AUTODETECT;
#endif

	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;

#if CONFIG_IS_ENABLED(I2C_EEPROM)
	if (action == EEPROM_LIST)
		return do_eeprom_list();
#endif

#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
	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

	ret = parse_eeprom_dev_spec(&dev,
				    argc - eeprom_action_expected_argc(action),
				    argv + index);
	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

	eeprom_dev_spec_init(&dev);

	switch (action) {
	case EEPROM_READ:
	case EEPROM_WRITE:
		return do_eeprom_rw(&dev, action == EEPROM_READ,
				    addr, off, cnt);
#ifdef CONFIG_CMD_EEPROM_LAYOUT
	case EEPROM_PRINT:
		return do_eeprom_print(&dev, layout_ver);
	case EEPROM_UPDATE:
		return do_eeprom_update(&dev, layout_ver,
					field_name, field_value);
#endif
	default:
		return CMD_RET_USAGE;
	}
}

#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
#define EEPROM_LAYOUT_SPEC	"[-l <layout_version>] "
#else
#define EEPROM_LAYOUT_SPEC	""
#endif

#if CONFIG_IS_ENABLED(I2C_EEPROM)
# define EEPROM_DEV_SPEC	"[device_specifier]"
#else
# define EEPROM_DEV_SPEC	"[[bus] devaddr]"
#endif

U_BOOT_CMD(
	eeprom,	8,	1,	do_eeprom,
	"EEPROM sub-system",
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	"list\n"
	"eeprom "
#endif
	"read  " EEPROM_DEV_SPEC " addr off cnt\n"
	"eeprom write " EEPROM_DEV_SPEC " addr off cnt\n"
	"       - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
#ifdef CONFIG_CMD_EEPROM_LAYOUT
	"\n"
	"eeprom print " EEPROM_LAYOUT_SPEC EEPROM_DEV_SPEC "\n"
	"       - Print layout fields and their data in human readable format\n"
	"eeprom update " EEPROM_LAYOUT_SPEC EEPROM_DEV_SPEC " 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."
#endif
#if CONFIG_IS_ENABLED(I2C_EEPROM)
	"\n\n"
	"DEVICE SPECIFIER - the eeprom device can be specified\n"
	"  [dev_name] - by device name (devices can listed with the eeprom list command)\n"
	"  [[bus] devaddr] - or by I2C bus and I2C device address\n"
	"If no device specifier is given, the first driver-model found device is used."
#endif
#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
	"\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>
57a9e8d8	24	#include <dm.h>
cb3ef681	25	#include <eeprom.h>
3863585b	26	#include <i2c.h>
57a9e8d8	27	#include <i2c_eeprom.h>
e7c2729b	28	#include <eeprom_layout.h>
03de305e	29	#include <vsprintf.h>
c05ed00a	30	#include <linux/delay.h>
3863585b	31
a6e7b774 MS	32	#ifndef I2C_RXTX_LEN
	33	#define I2C_RXTX_LEN 128
	34	#endif
	35
6717e3c8 MV	36	#define EEPROM_PAGE_SIZE (1 << CONFIG_SYS_EEPROM_PAGE_WRITE_BITS)
	37	#define EEPROM_PAGE_OFFSET(x) ((x) & (EEPROM_PAGE_SIZE - 1))
	38
2147a169	39	#if CONFIG_IS_ENABLED(DM_I2C)
ce976071	40	static int eeprom_i2c_bus;
4f256177 SG	41	#endif
4f256177 SG	42
52cd47c9 MV	43	__weak int eeprom_write_enable(unsigned dev_addr, int state)
	44	{
	45	return 0;
	46	}
4f296d09	47
354e3ed7	48	void eeprom_init(int bus)
4f296d09	49	{
4f296d09	50	/* I2C EEPROM */
2147a169	51	#if CONFIG_IS_ENABLED(DM_I2C)
4f256177	52	eeprom_i2c_bus = bus;
55dabcc8	53	#elif CONFIG_IS_ENABLED(SYS_I2C_LEGACY)
354e3ed7 MV	54	if (bus >= 0)
354e3ed7 MV	55	i2c_set_bus_num(bus);
4f296d09 MV	56	i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
	57	#endif
	58	}
	59
88cd7d0e TR	60	/*
	61	* for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 2 (16-bit EEPROM address) offset is
	62	* 0x000nxxxx for EEPROM address selectors at n, offset xxxx in EEPROM.
	63	*
	64	* for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1 (8-bit EEPROM page address) offset is
	65	* 0x00000nxx for EEPROM address selectors and page number at n.
	66	*/
02c321cf MV	67	static int eeprom_addr(unsigned dev_addr, unsigned offset, uchar *addr)
	68	{
	69	unsigned blk_off;
	70	int alen;
	71
	72	blk_off = offset & 0xff; /* block offset */
	73	#if CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1
	74	addr[0] = offset >> 8; /* block number */
	75	addr[1] = blk_off; /* block offset */
	76	alen = 2;
	77	#else
	78	addr[0] = offset >> 16; /* block number */
	79	addr[1] = offset >> 8; /* upper address octet */
	80	addr[2] = blk_off; /* lower address octet */
	81	alen = 3;
	82	#endif /* CONFIG_SYS_I2C_EEPROM_ADDR_LEN */
	83
	84	addr[0] \|= dev_addr; /* insert device address */
	85
	86	return alen;
	87	}
	88
39b6f98b MV	89	static int eeprom_len(unsigned offset, unsigned end)
	90	{
	91	unsigned len = end - offset;
	92
	93	/*
	94	* For a FRAM device there is no limit on the number of the
35087fb4	95	* bytes that can be accessed with the single read or write
39b6f98b MV	96	* operation.
	97	*/
	98	#if !defined(CONFIG_SYS_I2C_FRAM)
	99	unsigned blk_off = offset & 0xff;
	100	unsigned maxlen = EEPROM_PAGE_SIZE - EEPROM_PAGE_OFFSET(blk_off);
	101
	102	if (maxlen > I2C_RXTX_LEN)
	103	maxlen = I2C_RXTX_LEN;
	104
	105	if (len > maxlen)
	106	len = maxlen;
	107	#endif
	108
	109	return len;
	110	}
	111
9132088b MV	112	static int eeprom_rw_block(unsigned offset, uchar *addr, unsigned alen,
	113	uchar *buffer, unsigned len, bool read)
	114	{
	115	int ret = 0;
	116
2147a169	117	#if CONFIG_IS_ENABLED(DM_I2C)
0c07a9b4 LM	118	struct udevice *dev;
0c07a9b4 LM	119
4f256177	120	ret = i2c_get_chip_for_busnum(eeprom_i2c_bus, addr[0],
0c07a9b4 LM	121	alen - 1, &dev);
	122	if (ret) {
	123	printf("%s: Cannot find udev for a bus %d\n", __func__,
4f256177	124	eeprom_i2c_bus);
0c07a9b4 LM	125	return CMD_RET_FAILURE;
	126	}
	127
	128	if (read)
	129	ret = dm_i2c_read(dev, offset, buffer, len);
	130	else
	131	ret = dm_i2c_write(dev, offset, buffer, len);
	132
	133	#else /* Non DM I2C support - will be removed */
9132088b MV	134
	135	if (read)
	136	ret = i2c_read(addr[0], offset, alen - 1, buffer, len);
	137	else
	138	ret = i2c_write(addr[0], offset, alen - 1, buffer, len);
4f256177	139	#endif /* CONFIG_DM_I2C */
0c07a9b4 LM	140	if (ret)
	141	ret = CMD_RET_FAILURE;
	142
9132088b MV	143	return ret;
	144	}
	145
1a37889b MV	146	static int eeprom_rw(unsigned dev_addr, unsigned offset, uchar *buffer,
1a37889b MV	147	unsigned cnt, bool read)
3863585b WD	148	{
3863585b WD	149	unsigned end = offset + cnt;
1a37889b	150	unsigned alen, len;
3863585b	151	int rcode = 0;
02c321cf	152	uchar addr[3];
3863585b	153
e3c2042a	154	#if !CONFIG_IS_ENABLED(DM_I2C) && defined(CONFIG_SYS_I2C_EEPROM_BUS)
4f256177 SG	155	eeprom_init(CONFIG_SYS_I2C_EEPROM_BUS);
	156	#endif
	157
3863585b	158	while (offset < end) {
02c321cf	159	alen = eeprom_addr(dev_addr, offset, addr);
3863585b	160
39b6f98b	161	len = eeprom_len(offset, end);
d4f5c728	162
1a37889b	163	rcode = eeprom_rw_block(offset, addr, alen, buffer, len, read);
9132088b	164
3863585b WD	165	buffer += len;
3863585b WD	166	offset += len;
1a37889b	167
88cd7d0e	168	#if CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS > 0
1a37889b MV	169	if (!read)
1a37889b MV	170	udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS * 1000);
88cd7d0e	171	#endif
3863585b	172	}
d4f5c728	173
3863585b WD	174	return rcode;
	175	}
	176
1a37889b	177	int eeprom_read(unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt)
3863585b	178	{
1a37889b MV	179	/*
	180	* Read data until done or would cross a page boundary.
	181	* We must write the address again when changing pages
	182	* because the next page may be in a different device.
	183	*/
	184	return eeprom_rw(dev_addr, offset, buffer, cnt, 1);
	185	}
	186
d4e69e61 MV	187	int eeprom_write(unsigned dev_addr, unsigned offset,
d4e69e61 MV	188	uchar *buffer, unsigned cnt)
1a37889b MV	189	{
1a37889b MV	190	int ret;
3863585b	191
52cd47c9 MV	192	eeprom_write_enable(dev_addr, 1);
52cd47c9 MV	193
4f296d09 MV	194	/*
4f296d09 MV	195	* Write data until done or would cross a write page boundary.
3863585b WD	196	* We must write the address again when changing pages
	197	* because the address counter only increments within a page.
	198	*/
52bc7c7e	199	ret = eeprom_rw(dev_addr, offset, buffer, cnt, 0);
52cd47c9 MV	200
52cd47c9 MV	201	eeprom_write_enable(dev_addr, 0);
1a37889b	202	return ret;
3863585b WD	203	}
3863585b WD	204
aa59c1be	205	static long parse_numeric_param(char *str)
c40f0372 NK	206	{
c40f0372 NK	207	char *endptr;
aa59c1be	208	long value = simple_strtol(str, &endptr, 16);
c40f0372 NK	209
	210	return (*endptr != '\0') ? -1 : value;
	211	}
	212
15f0536f	213	struct eeprom_dev_spec {
57a9e8d8 MB	214	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	215	struct udevice *dev;
	216	#endif
15f0536f MB	217	int i2c_bus;
	218	ulong i2c_addr;
	219	};
	220
57a9e8d8 MB	221	static void eeprom_dev_spec_init(struct eeprom_dev_spec *dev)
	222	{
	223	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	224	if (!dev->dev)
	225	#endif
	226	eeprom_init(dev->i2c_bus);
	227	}
	228
	229	static int eeprom_dev_spec_read(struct eeprom_dev_spec *dev,
	230	unsigned offset, uchar *buffer, unsigned cnt)
	231	{
	232	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	233	if (dev->dev)
	234	return i2c_eeprom_read(dev->dev, offset, buffer, cnt);
	235	#endif
	236	return eeprom_read(dev->i2c_addr, offset, buffer, cnt);
	237	}
	238
	239	static int eeprom_dev_spec_write(struct eeprom_dev_spec *dev,
	240	unsigned offset, uchar *buffer, unsigned cnt)
	241	{
	242	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	243	if (dev->dev)
	244	return i2c_eeprom_write(dev->dev, offset, buffer, cnt);
	245	#endif
	246	return eeprom_write(dev->i2c_addr, offset, buffer, cnt);
	247	}
	248
c40f0372	249	/**
15f0536f	250	* parse_eeprom_dev_spec - parse the eeprom device specifier
c40f0372	251	*
15f0536f MB	252	* @dev: pointer to eeprom device specifier
	253	* @argc: count of command line arguments that can be used to parse
	254	* the device specifier
c40f0372	255	* @argv: command line arguments left to parse
c40f0372 NK	256	*
	257	* @returns: number of arguments parsed or CMD_RET_USAGE if error
	258	*/
15f0536f MB	259	static int parse_eeprom_dev_spec(struct eeprom_dev_spec *dev, int argc,
15f0536f MB	260	char *const argv[])
c40f0372	261	{
57a9e8d8 MB	262	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	263	if (argc == 0) {
	264	if (!uclass_first_device_err(UCLASS_I2C_EEPROM, &dev->dev))
	265	return 0;
	266	}
	267
	268	if (argc == 1) {
	269	if (!uclass_get_device_by_name(UCLASS_I2C_EEPROM, argv[0],
	270	&dev->dev))
	271	return 1;
	272
	273	/*
	274	* If we could not find the device by name and the parameter is
	275	* not numeric (and so won't be handled later), fail.
	276	*/
	277	if (parse_numeric_param(argv[0]) == -1) {
	278	printf("Can't get eeprom device: %s\n", argv[0]);
	279	return CMD_RET_USAGE;
	280	}
	281	}
	282	#endif
c40f0372	283
88cd7d0e	284	#ifdef CONFIG_SYS_I2C_EEPROM_ADDR
15f0536f MB	285	if (argc == 0) {
	286	dev->i2c_bus = -1;
	287	dev->i2c_addr = CONFIG_SYS_I2C_EEPROM_ADDR;
c40f0372 NK	288
	289	return 0;
	290	}
	291	#endif
15f0536f MB	292	if (argc == 1) {
	293	dev->i2c_bus = -1;
	294	dev->i2c_addr = parse_numeric_param(argv[0]);
c40f0372 NK	295
	296	return 1;
	297	}
	298
15f0536f MB	299	if (argc == 2) {
	300	dev->i2c_bus = parse_numeric_param(argv[0]);
	301	dev->i2c_addr = parse_numeric_param(argv[1]);
c40f0372 NK	302
	303	return 2;
	304	}
	305
	306	return CMD_RET_USAGE;
	307	}
	308
aa9e6044	309	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044	310
2d49dafe	311	#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
aa9e6044 NK	312	__weak int eeprom_parse_layout_version(char *str)
	313	{
	314	return LAYOUT_VERSION_UNRECOGNIZED;
	315	}
2d49dafe	316	#endif
aa9e6044 NK	317
	318	static unsigned char eeprom_buf[CONFIG_SYS_EEPROM_SIZE];
	319
e7c2729b NK	320	#endif
e7c2729b NK	321
aa9e6044	322	enum eeprom_action {
57a9e8d8	323	EEPROM_LIST,
e7c2729b NK	324	EEPROM_READ,
e7c2729b NK	325	EEPROM_WRITE,
aa9e6044 NK	326	EEPROM_PRINT,
	327	EEPROM_UPDATE,
	328	EEPROM_ACTION_INVALID,
	329	};
	330
	331	static enum eeprom_action parse_action(char *cmd)
	332	{
57a9e8d8 MB	333	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	334	if (!strncmp(cmd, "list", 4))
	335	return EEPROM_LIST;
	336	#endif
3dc9be82 NK	337	if (!strncmp(cmd, "read", 4))
	338	return EEPROM_READ;
	339	if (!strncmp(cmd, "write", 5))
	340	return EEPROM_WRITE;
	341	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044 NK	342	if (!strncmp(cmd, "print", 5))
	343	return EEPROM_PRINT;
	344	if (!strncmp(cmd, "update", 6))
	345	return EEPROM_UPDATE;
3dc9be82	346	#endif
aa9e6044 NK	347
	348	return EEPROM_ACTION_INVALID;
	349	}
	350
57a9e8d8 MB	351	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	352	static int do_eeprom_list(void)
	353	{
	354	struct udevice *dev;
	355	struct uclass *uc;
	356	int err;
	357
	358	err = uclass_get(UCLASS_I2C_EEPROM, &uc);
	359	if (err)
	360	return CMD_RET_FAILURE;
	361
	362	uclass_foreach_dev(dev, uc)
	363	printf("%s (%s)\n", dev->name, dev->driver->name);
	364
	365	return CMD_RET_SUCCESS;
	366	}
	367	#endif
	368
e9774afe MB	369	static int do_eeprom_rw(struct eeprom_dev_spec *dev, bool read,
e9774afe MB	370	ulong addr, ulong off, ulong cnt)
aa9e6044	371	{
e7c2729b	372	const char *const fmt =
6478a7ee	373	"\nEEPROM @0x%lX %s: addr 0x%08lx off 0x%04lx count %ld ... ";
e9774afe MB	374	uchar memloc = (uchar )addr;
	375	int ret;
	376
	377	printf(fmt, dev->i2c_addr, read ? "read" : "write", addr, off, cnt);
	378	if (read)
57a9e8d8	379	ret = eeprom_dev_spec_read(dev, off, memloc, cnt);
e9774afe	380	else
57a9e8d8	381	ret = eeprom_dev_spec_write(dev, off, memloc, cnt);
e9774afe MB	382	puts("done\n");
	383
	384	return ret;
	385	}
	386
e7c2729b	387	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044	388
e9774afe MB	389	static int do_eeprom_layout(struct eeprom_dev_spec *dev, int layout_ver,
	390	struct eeprom_layout *layout)
	391	{
e9774afe MB	392	eeprom_layout_setup(layout, eeprom_buf, CONFIG_SYS_EEPROM_SIZE,
e9774afe MB	393	layout_ver);
aa9e6044	394
57a9e8d8	395	return eeprom_dev_spec_read(dev, 0, eeprom_buf, layout->data_size);
e9774afe	396	}
e7c2729b	397
e9774afe MB	398	static int do_eeprom_print(struct eeprom_dev_spec *dev, int layout_ver)
	399	{
	400	struct eeprom_layout layout;
	401	int ret;
e7c2729b	402
e9774afe MB	403	ret = do_eeprom_layout(dev, layout_ver, &layout);
	404	if (ret)
	405	return ret;
e7c2729b	406
e9774afe	407	layout.print(&layout);
e7c2729b	408
e9774afe MB	409	return 0;
e9774afe MB	410	}
e7c2729b	411
e9774afe MB	412	static int do_eeprom_update(struct eeprom_dev_spec *dev, int layout_ver,
	413	char key, char value)
	414	{
	415	struct eeprom_layout layout;
	416	int ret;
aa9e6044	417
e9774afe MB	418	ret = do_eeprom_layout(dev, layout_ver, &layout);
	419	if (ret)
	420	return ret;
aa9e6044	421
e9774afe MB	422	ret = layout.update(&layout, key, value);
	423	if (ret)
	424	return CMD_RET_FAILURE;
aa9e6044	425
57a9e8d8	426	return eeprom_dev_spec_write(dev, 0, layout.data, layout.data_size);
aa9e6044	427	}
aa9e6044	428
e7c2729b	429	#endif
aa9e6044	430
fda747c8 MB	431	static int eeprom_action_expected_argc(enum eeprom_action action)
	432	{
	433	switch (action) {
57a9e8d8 MB	434	case EEPROM_LIST:
57a9e8d8 MB	435	return 0;
fda747c8 MB	436	case EEPROM_READ:
	437	case EEPROM_WRITE:
	438	return 3;
	439	case EEPROM_PRINT:
	440	return 0;
	441	case EEPROM_UPDATE:
	442	return 2;
	443	default:
	444	return CMD_RET_USAGE;
	445	}
aa9e6044 NK	446	}
	447
	448	#define NEXT_PARAM(argc, index) { (argc)--; (index)++; }
09140113	449	int do_eeprom(struct cmd_tbl cmdtp, int flag, int argc, char const argv[])
aa9e6044	450	{
aa9e6044	451	enum eeprom_action action = EEPROM_ACTION_INVALID;
15f0536f MB	452	struct eeprom_dev_spec dev;
	453	ulong addr = 0, cnt = 0, off = 0;
	454	int ret, index = 0;
e9774afe	455	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044 NK	456	char *field_name = "";
aa9e6044 NK	457	char *field_value = "";
e9774afe MB	458	int layout_ver = LAYOUT_VERSION_AUTODETECT;
e9774afe MB	459	#endif
aa9e6044 NK	460
	461	if (argc <= 1)
	462	return CMD_RET_USAGE;
	463
	464	NEXT_PARAM(argc, index); /* Skip program name */
	465
	466	action = parse_action(argv[index]);
	467	NEXT_PARAM(argc, index);
	468
3dc9be82	469	if (action == EEPROM_ACTION_INVALID)
aa9e6044 NK	470	return CMD_RET_USAGE;
aa9e6044 NK	471
57a9e8d8 MB	472	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	473	if (action == EEPROM_LIST)
	474	return do_eeprom_list();
	475	#endif
	476
2d49dafe	477	#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
3dc9be82 NK	478	if (action == EEPROM_PRINT \|\| action == EEPROM_UPDATE) {
	479	if (!strcmp(argv[index], "-l")) {
	480	NEXT_PARAM(argc, index);
	481	layout_ver = eeprom_parse_layout_version(argv[index]);
	482	NEXT_PARAM(argc, index);
	483	}
aa9e6044	484	}
3dc9be82	485	#endif
aa9e6044	486
15f0536f MB	487	ret = parse_eeprom_dev_spec(&dev,
	488	argc - eeprom_action_expected_argc(action),
	489	argv + index);
3dc9be82 NK	490	if (ret == CMD_RET_USAGE)
3dc9be82 NK	491	return ret;
aa9e6044	492
3dc9be82	493	while (ret--)
aa9e6044	494	NEXT_PARAM(argc, index);
aa9e6044	495
3dc9be82 NK	496	if (action == EEPROM_READ \|\| action == EEPROM_WRITE) {
	497	addr = parse_numeric_param(argv[index]);
	498	NEXT_PARAM(argc, index);
	499	off = parse_numeric_param(argv[index]);
aa9e6044	500	NEXT_PARAM(argc, index);
3dc9be82	501	cnt = parse_numeric_param(argv[index]);
aa9e6044 NK	502	}
aa9e6044 NK	503
aa9e6044	504	#ifdef CONFIG_CMD_EEPROM_LAYOUT
3dc9be82 NK	505	if (action == EEPROM_UPDATE) {
	506	field_name = argv[index];
	507	NEXT_PARAM(argc, index);
	508	field_value = argv[index];
	509	NEXT_PARAM(argc, index);
aa9e6044 NK	510	}
	511	#endif
	512
57a9e8d8	513	eeprom_dev_spec_init(&dev);
e9774afe MB	514
	515	switch (action) {
	516	case EEPROM_READ:
	517	case EEPROM_WRITE:
	518	return do_eeprom_rw(&dev, action == EEPROM_READ,
	519	addr, off, cnt);
	520	#ifdef CONFIG_CMD_EEPROM_LAYOUT
	521	case EEPROM_PRINT:
	522	return do_eeprom_print(&dev, layout_ver);
	523	case EEPROM_UPDATE:
	524	return do_eeprom_update(&dev, layout_ver,
	525	field_name, field_value);
	526	#endif
	527	default:
	528	return CMD_RET_USAGE;
	529	}
4f296d09	530	}
8bde7f77	531
2d49dafe MB	532	#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
	533	#define EEPROM_LAYOUT_SPEC "[-l <layout_version>] "
	534	#else
	535	#define EEPROM_LAYOUT_SPEC ""
	536	#endif
	537
57a9e8d8 MB	538	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	539	# define EEPROM_DEV_SPEC "[device_specifier]"
	540	#else
	541	# define EEPROM_DEV_SPEC "[[bus] devaddr]"
	542	#endif
	543
0d498393	544	U_BOOT_CMD(
aa9e6044	545	eeprom, 8, 1, do_eeprom,
2fb2604d	546	"EEPROM sub-system",
57a9e8d8 MB	547	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	548	"list\n"
	549	"eeprom "
	550	#endif
	551	"read " EEPROM_DEV_SPEC " addr off cnt\n"
	552	"eeprom write " EEPROM_DEV_SPEC " addr off cnt\n"
a89c33db	553	" - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
aa9e6044 NK	554	#ifdef CONFIG_CMD_EEPROM_LAYOUT
aa9e6044 NK	555	"\n"
57a9e8d8	556	"eeprom print " EEPROM_LAYOUT_SPEC EEPROM_DEV_SPEC "\n"
aa9e6044	557	" - Print layout fields and their data in human readable format\n"
57a9e8d8	558	"eeprom update " EEPROM_LAYOUT_SPEC EEPROM_DEV_SPEC " field_name field_value\n"
aa9e6044	559	" - Update a specific eeprom field with new data.\n"
2d49dafe	560	" The new data must be written in the same human readable format as shown by the print command."
57a9e8d8 MB	561	#endif
	562	#if CONFIG_IS_ENABLED(I2C_EEPROM)
	563	"\n\n"
	564	"DEVICE SPECIFIER - the eeprom device can be specified\n"
	565	" [dev_name] - by device name (devices can listed with the eeprom list command)\n"
	566	" [[bus] devaddr] - or by I2C bus and I2C device address\n"
	567	"If no device specifier is given, the first driver-model found device is used."
	568	#endif
2d49dafe MB	569	#ifdef CONFIG_EEPROM_LAYOUT_VERSIONS
2d49dafe MB	570	"\n\n"
aa9e6044 NK	571	"LAYOUT VERSIONS\n"
	572	"The -l option can be used to force the command to interpret the EEPROM data using the chosen layout.\n"
	573	"If the -l option is omitted, the command will auto detect the layout based on the data in the EEPROM.\n"
	574	"The values which can be provided with the -l option are:\n"
	575	CONFIG_EEPROM_LAYOUT_HELP_STRING"\n"
	576	#endif
10c398d6	577	);