2 * (C) Copyright 2000, 2001
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
9 * Support for read and write access to EEPROM like memory devices. This
10 * includes regular EEPROM as well as FRAM (ferroelectic nonvolaile RAM).
11 * FRAM devices read and write data at bus speed. In particular, there is no
12 * write delay. Also, there is no limit imposed on the number of bytes that can
13 * be transferred with a single read or write.
15 * Use the following configuration options to ensure no unneeded performance
16 * degradation (typical for EEPROM) is incured for FRAM memory:
18 * #define CONFIG_SYS_I2C_FRAM
19 * #undef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
27 #include <eeprom_layout.h>
29 #ifndef CONFIG_SYS_I2C_SPEED
30 #define CONFIG_SYS_I2C_SPEED 50000
33 #ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
34 #define CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS 0
37 #ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_BITS
38 #define CONFIG_SYS_EEPROM_PAGE_WRITE_BITS 8
42 #define I2C_RXTX_LEN 128
45 #define EEPROM_PAGE_SIZE (1 << CONFIG_SYS_EEPROM_PAGE_WRITE_BITS)
46 #define EEPROM_PAGE_OFFSET(x) ((x) & (EEPROM_PAGE_SIZE - 1))
49 * for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 2 (16-bit EEPROM address) offset is
50 * 0x000nxxxx for EEPROM address selectors at n, offset xxxx in EEPROM.
52 * for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1 (8-bit EEPROM page address) offset is
53 * 0x00000nxx for EEPROM address selectors and page number at n.
55 #if !defined(CONFIG_SPI) || defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
56 #if !defined(CONFIG_SYS_I2C_EEPROM_ADDR_LEN) || \
57 (CONFIG_SYS_I2C_EEPROM_ADDR_LEN < 1) || \
58 (CONFIG_SYS_I2C_EEPROM_ADDR_LEN > 2)
59 #error CONFIG_SYS_I2C_EEPROM_ADDR_LEN must be 1 or 2
63 __weak int eeprom_write_enable(unsigned dev_addr, int state)
68 void eeprom_init(int bus)
71 #if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
76 #if defined(CONFIG_SYS_I2C)
79 i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
83 static int eeprom_addr(unsigned dev_addr, unsigned offset, uchar *addr)
88 blk_off = offset & 0xff; /* block offset */
89 #if CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1
90 addr[0] = offset >> 8; /* block number */
91 addr[1] = blk_off; /* block offset */
94 addr[0] = offset >> 16; /* block number */
95 addr[1] = offset >> 8; /* upper address octet */
96 addr[2] = blk_off; /* lower address octet */
98 #endif /* CONFIG_SYS_I2C_EEPROM_ADDR_LEN */
100 addr[0] |= dev_addr; /* insert device address */
105 static int eeprom_len(unsigned offset, unsigned end)
107 unsigned len = end - offset;
110 * For a FRAM device there is no limit on the number of the
111 * bytes that can be ccessed with the single read or write
114 #if !defined(CONFIG_SYS_I2C_FRAM)
115 unsigned blk_off = offset & 0xff;
116 unsigned maxlen = EEPROM_PAGE_SIZE - EEPROM_PAGE_OFFSET(blk_off);
118 if (maxlen > I2C_RXTX_LEN)
119 maxlen = I2C_RXTX_LEN;
128 static int eeprom_rw_block(unsigned offset, uchar *addr, unsigned alen,
129 uchar *buffer, unsigned len, bool read)
134 #if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
136 spi_read(addr, alen, buffer, len);
138 spi_write(addr, alen, buffer, len);
141 #if defined(CONFIG_SYS_I2C_EEPROM_BUS)
142 i2c_set_bus_num(CONFIG_SYS_I2C_EEPROM_BUS);
146 ret = i2c_read(addr[0], offset, alen - 1, buffer, len);
148 ret = i2c_write(addr[0], offset, alen - 1, buffer, len);
156 static int eeprom_rw(unsigned dev_addr, unsigned offset, uchar *buffer,
157 unsigned cnt, bool read)
159 unsigned end = offset + cnt;
164 while (offset < end) {
165 alen = eeprom_addr(dev_addr, offset, addr);
167 len = eeprom_len(offset, end);
169 rcode = eeprom_rw_block(offset, addr, alen, buffer, len, read);
175 udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS * 1000);
181 int eeprom_read(unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt)
184 * Read data until done or would cross a page boundary.
185 * We must write the address again when changing pages
186 * because the next page may be in a different device.
188 return eeprom_rw(dev_addr, offset, buffer, cnt, 1);
191 int eeprom_write(unsigned dev_addr, unsigned offset,
192 uchar *buffer, unsigned cnt)
196 eeprom_write_enable(dev_addr, 1);
199 * Write data until done or would cross a write page boundary.
200 * We must write the address again when changing pages
201 * because the address counter only increments within a page.
203 ret = eeprom_rw(dev_addr, offset, buffer, cnt, 0);
205 eeprom_write_enable(dev_addr, 0);
209 static int parse_numeric_param(char *str)
212 int value = simple_strtol(str, &endptr, 16);
214 return (*endptr != '\0') ? -1 : value;
218 * parse_i2c_bus_addr - parse the i2c bus and i2c devaddr parameters
220 * @i2c_bus: address to store the i2c bus
221 * @i2c_addr: address to store the device i2c address
222 * @argc: count of command line arguments left to parse
223 * @argv: command line arguments left to parse
224 * @argc_no_bus_addr: argc value we expect to see when bus & addr aren't given
226 * @returns: number of arguments parsed or CMD_RET_USAGE if error
228 static int parse_i2c_bus_addr(int *i2c_bus, ulong *i2c_addr, int argc,
229 char * const argv[], int argc_no_bus_addr)
231 int argc_no_bus = argc_no_bus_addr + 1;
232 int argc_bus_addr = argc_no_bus_addr + 2;
234 #ifdef CONFIG_SYS_DEF_EEPROM_ADDR
235 if (argc == argc_no_bus_addr) {
237 *i2c_addr = CONFIG_SYS_DEF_EEPROM_ADDR;
242 if (argc == argc_no_bus) {
244 *i2c_addr = parse_numeric_param(argv[0]);
249 if (argc == argc_bus_addr) {
250 *i2c_bus = parse_numeric_param(argv[0]);
251 *i2c_addr = parse_numeric_param(argv[1]);
256 return CMD_RET_USAGE;
259 #ifdef CONFIG_CMD_EEPROM_LAYOUT
261 __weak int eeprom_parse_layout_version(char *str)
263 return LAYOUT_VERSION_UNRECOGNIZED;
266 static unsigned char eeprom_buf[CONFIG_SYS_EEPROM_SIZE];
275 EEPROM_ACTION_INVALID,
278 static enum eeprom_action parse_action(char *cmd)
280 if (!strncmp(cmd, "read", 4))
282 if (!strncmp(cmd, "write", 5))
284 #ifdef CONFIG_CMD_EEPROM_LAYOUT
285 if (!strncmp(cmd, "print", 5))
287 if (!strncmp(cmd, "update", 6))
288 return EEPROM_UPDATE;
291 return EEPROM_ACTION_INVALID;
294 static int eeprom_execute_command(enum eeprom_action action, int i2c_bus,
295 ulong i2c_addr, int layout_ver, char *key,
296 char *value, ulong addr, ulong off, ulong cnt)
299 const char *const fmt =
300 "\nEEPROM @0x%lX %s: addr %08lx off %04lx count %ld ... ";
301 #ifdef CONFIG_CMD_EEPROM_LAYOUT
302 struct eeprom_layout layout;
305 if (action == EEPROM_ACTION_INVALID)
306 return CMD_RET_USAGE;
308 eeprom_init(i2c_bus);
309 if (action == EEPROM_READ) {
310 printf(fmt, i2c_addr, "read", addr, off, cnt);
312 rcode = eeprom_read(i2c_addr, off, (uchar *)addr, cnt);
316 } else if (action == EEPROM_WRITE) {
317 printf(fmt, i2c_addr, "write", addr, off, cnt);
319 rcode = eeprom_write(i2c_addr, off, (uchar *)addr, cnt);
325 #ifdef CONFIG_CMD_EEPROM_LAYOUT
326 rcode = eeprom_read(i2c_addr, 0, eeprom_buf, CONFIG_SYS_EEPROM_SIZE);
330 eeprom_layout_setup(&layout, eeprom_buf, CONFIG_SYS_EEPROM_SIZE,
333 if (action == EEPROM_PRINT) {
334 layout.print(&layout);
338 layout.update(&layout, key, value);
340 rcode = eeprom_write(i2c_addr, 0, layout.data, CONFIG_SYS_EEPROM_SIZE);
346 #define NEXT_PARAM(argc, index) { (argc)--; (index)++; }
347 int do_eeprom(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
349 int layout_ver = LAYOUT_VERSION_AUTODETECT;
350 enum eeprom_action action = EEPROM_ACTION_INVALID;
351 int i2c_bus = -1, index = 0;
352 ulong i2c_addr = -1, addr = 0, cnt = 0, off = 0;
354 char *field_name = "";
355 char *field_value = "";
358 return CMD_RET_USAGE;
360 NEXT_PARAM(argc, index); /* Skip program name */
362 action = parse_action(argv[index]);
363 NEXT_PARAM(argc, index);
365 if (action == EEPROM_ACTION_INVALID)
366 return CMD_RET_USAGE;
368 #ifdef CONFIG_CMD_EEPROM_LAYOUT
369 if (action == EEPROM_PRINT || action == EEPROM_UPDATE) {
370 if (!strcmp(argv[index], "-l")) {
371 NEXT_PARAM(argc, index);
372 layout_ver = eeprom_parse_layout_version(argv[index]);
373 NEXT_PARAM(argc, index);
381 ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
385 ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
389 ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
393 /* Get compiler to stop whining */
394 return CMD_RET_USAGE;
397 if (ret == CMD_RET_USAGE)
401 NEXT_PARAM(argc, index);
403 if (action == EEPROM_READ || action == EEPROM_WRITE) {
404 addr = parse_numeric_param(argv[index]);
405 NEXT_PARAM(argc, index);
406 off = parse_numeric_param(argv[index]);
407 NEXT_PARAM(argc, index);
408 cnt = parse_numeric_param(argv[index]);
411 #ifdef CONFIG_CMD_EEPROM_LAYOUT
412 if (action == EEPROM_UPDATE) {
413 field_name = argv[index];
414 NEXT_PARAM(argc, index);
415 field_value = argv[index];
416 NEXT_PARAM(argc, index);
420 return eeprom_execute_command(action, i2c_bus, i2c_addr, layout_ver,
421 field_name, field_value, addr, off, cnt);
425 eeprom, 8, 1, do_eeprom,
427 "read <bus> <devaddr> addr off cnt\n"
428 "eeprom write <bus> <devaddr> addr off cnt\n"
429 " - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
430 #ifdef CONFIG_CMD_EEPROM_LAYOUT
432 "eeprom print [-l <layout_version>] <bus> <devaddr>\n"
433 " - Print layout fields and their data in human readable format\n"
434 "eeprom update [-l <layout_version>] <bus> <devaddr> field_name field_value\n"
435 " - Update a specific eeprom field with new data.\n"
436 " The new data must be written in the same human readable format as shown by the print command.\n"
439 "The -l option can be used to force the command to interpret the EEPROM data using the chosen layout.\n"
440 "If the -l option is omitted, the command will auto detect the layout based on the data in the EEPROM.\n"
441 "The values which can be provided with the -l option are:\n"
442 CONFIG_EEPROM_LAYOUT_HELP_STRING"\n"