1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000, 2001
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
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
11 * write delay. Also, there is no limit imposed on the number of bytes that can
12 * be transferred with a single read or write.
14 * Use the following configuration options to ensure no unneeded performance
15 * degradation (typical for EEPROM) is incured for FRAM memory:
17 * #define CONFIG_SYS_I2C_FRAM
18 * #undef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
26 #include <eeprom_layout.h>
28 #ifndef CONFIG_SYS_I2C_SPEED
29 #define CONFIG_SYS_I2C_SPEED 50000
32 #ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
33 #define CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS 0
36 #ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_BITS
37 #define CONFIG_SYS_EEPROM_PAGE_WRITE_BITS 8
41 #define I2C_RXTX_LEN 128
44 #define EEPROM_PAGE_SIZE (1 << CONFIG_SYS_EEPROM_PAGE_WRITE_BITS)
45 #define EEPROM_PAGE_OFFSET(x) ((x) & (EEPROM_PAGE_SIZE - 1))
48 * for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 2 (16-bit EEPROM address) offset is
49 * 0x000nxxxx for EEPROM address selectors at n, offset xxxx in EEPROM.
51 * for CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1 (8-bit EEPROM page address) offset is
52 * 0x00000nxx for EEPROM address selectors and page number at n.
54 #if !defined(CONFIG_SPI) || defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
55 #if !defined(CONFIG_SYS_I2C_EEPROM_ADDR_LEN) || \
56 (CONFIG_SYS_I2C_EEPROM_ADDR_LEN < 1) || \
57 (CONFIG_SYS_I2C_EEPROM_ADDR_LEN > 2)
58 #error CONFIG_SYS_I2C_EEPROM_ADDR_LEN must be 1 or 2
62 __weak
int eeprom_write_enable(unsigned dev_addr
, int state
)
67 void eeprom_init(int bus
)
70 #if defined(CONFIG_SYS_I2C)
73 i2c_init(CONFIG_SYS_I2C_SPEED
, CONFIG_SYS_I2C_SLAVE
);
77 static int eeprom_addr(unsigned dev_addr
, unsigned offset
, uchar
*addr
)
82 blk_off
= offset
& 0xff; /* block offset */
83 #if CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1
84 addr
[0] = offset
>> 8; /* block number */
85 addr
[1] = blk_off
; /* block offset */
88 addr
[0] = offset
>> 16; /* block number */
89 addr
[1] = offset
>> 8; /* upper address octet */
90 addr
[2] = blk_off
; /* lower address octet */
92 #endif /* CONFIG_SYS_I2C_EEPROM_ADDR_LEN */
94 addr
[0] |= dev_addr
; /* insert device address */
99 static int eeprom_len(unsigned offset
, unsigned end
)
101 unsigned len
= end
- offset
;
104 * For a FRAM device there is no limit on the number of the
105 * bytes that can be ccessed with the single read or write
108 #if !defined(CONFIG_SYS_I2C_FRAM)
109 unsigned blk_off
= offset
& 0xff;
110 unsigned maxlen
= EEPROM_PAGE_SIZE
- EEPROM_PAGE_OFFSET(blk_off
);
112 if (maxlen
> I2C_RXTX_LEN
)
113 maxlen
= I2C_RXTX_LEN
;
122 static int eeprom_rw_block(unsigned offset
, uchar
*addr
, unsigned alen
,
123 uchar
*buffer
, unsigned len
, bool read
)
127 #if defined(CONFIG_DM_I2C) && defined(CONFIG_SYS_I2C_EEPROM_BUS)
130 ret
= i2c_get_chip_for_busnum(CONFIG_SYS_I2C_EEPROM_BUS
, addr
[0],
133 printf("%s: Cannot find udev for a bus %d\n", __func__
,
134 CONFIG_SYS_I2C_EEPROM_BUS
);
135 return CMD_RET_FAILURE
;
139 ret
= dm_i2c_read(dev
, offset
, buffer
, len
);
141 ret
= dm_i2c_write(dev
, offset
, buffer
, len
);
143 #else /* Non DM I2C support - will be removed */
144 #if defined(CONFIG_SYS_I2C_EEPROM_BUS)
145 i2c_set_bus_num(CONFIG_SYS_I2C_EEPROM_BUS
);
149 ret
= i2c_read(addr
[0], offset
, alen
- 1, buffer
, len
);
151 ret
= i2c_write(addr
[0], offset
, alen
- 1, buffer
, len
);
152 #endif /* CONFIG_DM_I2C && CONFIG_SYS_I2C_EEPROM_BUS */
154 ret
= CMD_RET_FAILURE
;
159 static int eeprom_rw(unsigned dev_addr
, unsigned offset
, uchar
*buffer
,
160 unsigned cnt
, bool read
)
162 unsigned end
= offset
+ cnt
;
167 while (offset
< end
) {
168 alen
= eeprom_addr(dev_addr
, offset
, addr
);
170 len
= eeprom_len(offset
, end
);
172 rcode
= eeprom_rw_block(offset
, addr
, alen
, buffer
, len
, read
);
178 udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
* 1000);
184 int eeprom_read(unsigned dev_addr
, unsigned offset
, uchar
*buffer
, unsigned cnt
)
187 * Read data until done or would cross a page boundary.
188 * We must write the address again when changing pages
189 * because the next page may be in a different device.
191 return eeprom_rw(dev_addr
, offset
, buffer
, cnt
, 1);
194 int eeprom_write(unsigned dev_addr
, unsigned offset
,
195 uchar
*buffer
, unsigned cnt
)
199 eeprom_write_enable(dev_addr
, 1);
202 * Write data until done or would cross a write page boundary.
203 * We must write the address again when changing pages
204 * because the address counter only increments within a page.
206 ret
= eeprom_rw(dev_addr
, offset
, buffer
, cnt
, 0);
208 eeprom_write_enable(dev_addr
, 0);
212 static int parse_numeric_param(char *str
)
215 int value
= simple_strtol(str
, &endptr
, 16);
217 return (*endptr
!= '\0') ? -1 : value
;
221 * parse_i2c_bus_addr - parse the i2c bus and i2c devaddr parameters
223 * @i2c_bus: address to store the i2c bus
224 * @i2c_addr: address to store the device i2c address
225 * @argc: count of command line arguments left to parse
226 * @argv: command line arguments left to parse
227 * @argc_no_bus_addr: argc value we expect to see when bus & addr aren't given
229 * @returns: number of arguments parsed or CMD_RET_USAGE if error
231 static int parse_i2c_bus_addr(int *i2c_bus
, ulong
*i2c_addr
, int argc
,
232 char * const argv
[], int argc_no_bus_addr
)
234 int argc_no_bus
= argc_no_bus_addr
+ 1;
235 int argc_bus_addr
= argc_no_bus_addr
+ 2;
237 #ifdef CONFIG_SYS_DEF_EEPROM_ADDR
238 if (argc
== argc_no_bus_addr
) {
240 *i2c_addr
= CONFIG_SYS_DEF_EEPROM_ADDR
;
245 if (argc
== argc_no_bus
) {
247 *i2c_addr
= parse_numeric_param(argv
[0]);
252 if (argc
== argc_bus_addr
) {
253 *i2c_bus
= parse_numeric_param(argv
[0]);
254 *i2c_addr
= parse_numeric_param(argv
[1]);
259 return CMD_RET_USAGE
;
262 #ifdef CONFIG_CMD_EEPROM_LAYOUT
264 __weak
int eeprom_parse_layout_version(char *str
)
266 return LAYOUT_VERSION_UNRECOGNIZED
;
269 static unsigned char eeprom_buf
[CONFIG_SYS_EEPROM_SIZE
];
278 EEPROM_ACTION_INVALID
,
281 static enum eeprom_action
parse_action(char *cmd
)
283 if (!strncmp(cmd
, "read", 4))
285 if (!strncmp(cmd
, "write", 5))
287 #ifdef CONFIG_CMD_EEPROM_LAYOUT
288 if (!strncmp(cmd
, "print", 5))
290 if (!strncmp(cmd
, "update", 6))
291 return EEPROM_UPDATE
;
294 return EEPROM_ACTION_INVALID
;
297 static int eeprom_execute_command(enum eeprom_action action
, int i2c_bus
,
298 ulong i2c_addr
, int layout_ver
, char *key
,
299 char *value
, ulong addr
, ulong off
, ulong cnt
)
302 const char *const fmt
=
303 "\nEEPROM @0x%lX %s: addr %08lx off %04lx count %ld ... ";
304 #ifdef CONFIG_CMD_EEPROM_LAYOUT
305 struct eeprom_layout layout
;
308 if (action
== EEPROM_ACTION_INVALID
)
309 return CMD_RET_USAGE
;
311 eeprom_init(i2c_bus
);
312 if (action
== EEPROM_READ
) {
313 printf(fmt
, i2c_addr
, "read", addr
, off
, cnt
);
315 rcode
= eeprom_read(i2c_addr
, off
, (uchar
*)addr
, cnt
);
319 } else if (action
== EEPROM_WRITE
) {
320 printf(fmt
, i2c_addr
, "write", addr
, off
, cnt
);
322 rcode
= eeprom_write(i2c_addr
, off
, (uchar
*)addr
, cnt
);
328 #ifdef CONFIG_CMD_EEPROM_LAYOUT
329 rcode
= eeprom_read(i2c_addr
, 0, eeprom_buf
, CONFIG_SYS_EEPROM_SIZE
);
333 eeprom_layout_setup(&layout
, eeprom_buf
, CONFIG_SYS_EEPROM_SIZE
,
336 if (action
== EEPROM_PRINT
) {
337 layout
.print(&layout
);
341 layout
.update(&layout
, key
, value
);
343 rcode
= eeprom_write(i2c_addr
, 0, layout
.data
, CONFIG_SYS_EEPROM_SIZE
);
349 #define NEXT_PARAM(argc, index) { (argc)--; (index)++; }
350 int do_eeprom(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
352 int layout_ver
= LAYOUT_VERSION_AUTODETECT
;
353 enum eeprom_action action
= EEPROM_ACTION_INVALID
;
354 int i2c_bus
= -1, index
= 0;
355 ulong i2c_addr
= -1, addr
= 0, cnt
= 0, off
= 0;
357 char *field_name
= "";
358 char *field_value
= "";
361 return CMD_RET_USAGE
;
363 NEXT_PARAM(argc
, index
); /* Skip program name */
365 action
= parse_action(argv
[index
]);
366 NEXT_PARAM(argc
, index
);
368 if (action
== EEPROM_ACTION_INVALID
)
369 return CMD_RET_USAGE
;
371 #ifdef CONFIG_CMD_EEPROM_LAYOUT
372 if (action
== EEPROM_PRINT
|| action
== EEPROM_UPDATE
) {
373 if (!strcmp(argv
[index
], "-l")) {
374 NEXT_PARAM(argc
, index
);
375 layout_ver
= eeprom_parse_layout_version(argv
[index
]);
376 NEXT_PARAM(argc
, index
);
384 ret
= parse_i2c_bus_addr(&i2c_bus
, &i2c_addr
, argc
,
388 ret
= parse_i2c_bus_addr(&i2c_bus
, &i2c_addr
, argc
,
392 ret
= parse_i2c_bus_addr(&i2c_bus
, &i2c_addr
, argc
,
396 /* Get compiler to stop whining */
397 return CMD_RET_USAGE
;
400 if (ret
== CMD_RET_USAGE
)
404 NEXT_PARAM(argc
, index
);
406 if (action
== EEPROM_READ
|| action
== EEPROM_WRITE
) {
407 addr
= parse_numeric_param(argv
[index
]);
408 NEXT_PARAM(argc
, index
);
409 off
= parse_numeric_param(argv
[index
]);
410 NEXT_PARAM(argc
, index
);
411 cnt
= parse_numeric_param(argv
[index
]);
414 #ifdef CONFIG_CMD_EEPROM_LAYOUT
415 if (action
== EEPROM_UPDATE
) {
416 field_name
= argv
[index
];
417 NEXT_PARAM(argc
, index
);
418 field_value
= argv
[index
];
419 NEXT_PARAM(argc
, index
);
423 return eeprom_execute_command(action
, i2c_bus
, i2c_addr
, layout_ver
,
424 field_name
, field_value
, addr
, off
, cnt
);
428 eeprom
, 8, 1, do_eeprom
,
430 "read <bus> <devaddr> addr off cnt\n"
431 "eeprom write <bus> <devaddr> addr off cnt\n"
432 " - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
433 #ifdef CONFIG_CMD_EEPROM_LAYOUT
435 "eeprom print [-l <layout_version>] <bus> <devaddr>\n"
436 " - Print layout fields and their data in human readable format\n"
437 "eeprom update [-l <layout_version>] <bus> <devaddr> field_name field_value\n"
438 " - Update a specific eeprom field with new data.\n"
439 " The new data must be written in the same human readable format as shown by the print command.\n"
442 "The -l option can be used to force the command to interpret the EEPROM data using the chosen layout.\n"
443 "If the -l option is omitted, the command will auto detect the layout based on the data in the EEPROM.\n"
444 "The values which can be provided with the -l option are:\n"
445 CONFIG_EEPROM_LAYOUT_HELP_STRING
"\n"