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_MPC8XX_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
75 #if defined(CONFIG_SYS_I2C)
78 i2c_init(CONFIG_SYS_I2C_SPEED
, CONFIG_SYS_I2C_SLAVE
);
82 static int eeprom_addr(unsigned dev_addr
, unsigned offset
, uchar
*addr
)
87 blk_off
= offset
& 0xff; /* block offset */
88 #if CONFIG_SYS_I2C_EEPROM_ADDR_LEN == 1
89 addr
[0] = offset
>> 8; /* block number */
90 addr
[1] = blk_off
; /* block offset */
93 addr
[0] = offset
>> 16; /* block number */
94 addr
[1] = offset
>> 8; /* upper address octet */
95 addr
[2] = blk_off
; /* lower address octet */
97 #endif /* CONFIG_SYS_I2C_EEPROM_ADDR_LEN */
99 addr
[0] |= dev_addr
; /* insert device address */
104 static int eeprom_len(unsigned offset
, unsigned end
)
106 unsigned len
= end
- offset
;
109 * For a FRAM device there is no limit on the number of the
110 * bytes that can be ccessed with the single read or write
113 #if !defined(CONFIG_SYS_I2C_FRAM)
114 unsigned blk_off
= offset
& 0xff;
115 unsigned maxlen
= EEPROM_PAGE_SIZE
- EEPROM_PAGE_OFFSET(blk_off
);
117 if (maxlen
> I2C_RXTX_LEN
)
118 maxlen
= I2C_RXTX_LEN
;
127 static int eeprom_rw_block(unsigned offset
, uchar
*addr
, unsigned alen
,
128 uchar
*buffer
, unsigned len
, bool read
)
133 #if defined(CONFIG_MPC8XX_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
135 spi_read(addr
, alen
, buffer
, len
);
137 spi_write(addr
, alen
, buffer
, len
);
140 #if defined(CONFIG_SYS_I2C_EEPROM_BUS)
141 i2c_set_bus_num(CONFIG_SYS_I2C_EEPROM_BUS
);
145 ret
= i2c_read(addr
[0], offset
, alen
- 1, buffer
, len
);
147 ret
= i2c_write(addr
[0], offset
, alen
- 1, buffer
, len
);
155 static int eeprom_rw(unsigned dev_addr
, unsigned offset
, uchar
*buffer
,
156 unsigned cnt
, bool read
)
158 unsigned end
= offset
+ cnt
;
163 while (offset
< end
) {
164 alen
= eeprom_addr(dev_addr
, offset
, addr
);
166 len
= eeprom_len(offset
, end
);
168 rcode
= eeprom_rw_block(offset
, addr
, alen
, buffer
, len
, read
);
174 udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
* 1000);
180 int eeprom_read(unsigned dev_addr
, unsigned offset
, uchar
*buffer
, unsigned cnt
)
183 * Read data until done or would cross a page boundary.
184 * We must write the address again when changing pages
185 * because the next page may be in a different device.
187 return eeprom_rw(dev_addr
, offset
, buffer
, cnt
, 1);
190 int eeprom_write(unsigned dev_addr
, unsigned offset
,
191 uchar
*buffer
, unsigned cnt
)
195 eeprom_write_enable(dev_addr
, 1);
198 * Write data until done or would cross a write page boundary.
199 * We must write the address again when changing pages
200 * because the address counter only increments within a page.
202 ret
= eeprom_rw(dev_addr
, offset
, buffer
, cnt
, 0);
204 eeprom_write_enable(dev_addr
, 0);
208 static int parse_numeric_param(char *str
)
211 int value
= simple_strtol(str
, &endptr
, 16);
213 return (*endptr
!= '\0') ? -1 : value
;
217 * parse_i2c_bus_addr - parse the i2c bus and i2c devaddr parameters
219 * @i2c_bus: address to store the i2c bus
220 * @i2c_addr: address to store the device i2c address
221 * @argc: count of command line arguments left to parse
222 * @argv: command line arguments left to parse
223 * @argc_no_bus_addr: argc value we expect to see when bus & addr aren't given
225 * @returns: number of arguments parsed or CMD_RET_USAGE if error
227 static int parse_i2c_bus_addr(int *i2c_bus
, ulong
*i2c_addr
, int argc
,
228 char * const argv
[], int argc_no_bus_addr
)
230 int argc_no_bus
= argc_no_bus_addr
+ 1;
231 int argc_bus_addr
= argc_no_bus_addr
+ 2;
233 #ifdef CONFIG_SYS_DEF_EEPROM_ADDR
234 if (argc
== argc_no_bus_addr
) {
236 *i2c_addr
= CONFIG_SYS_DEF_EEPROM_ADDR
;
241 if (argc
== argc_no_bus
) {
243 *i2c_addr
= parse_numeric_param(argv
[0]);
248 if (argc
== argc_bus_addr
) {
249 *i2c_bus
= parse_numeric_param(argv
[0]);
250 *i2c_addr
= parse_numeric_param(argv
[1]);
255 return CMD_RET_USAGE
;
258 #ifdef CONFIG_CMD_EEPROM_LAYOUT
260 __weak
int eeprom_parse_layout_version(char *str
)
262 return LAYOUT_VERSION_UNRECOGNIZED
;
265 static unsigned char eeprom_buf
[CONFIG_SYS_EEPROM_SIZE
];
274 EEPROM_ACTION_INVALID
,
277 static enum eeprom_action
parse_action(char *cmd
)
279 if (!strncmp(cmd
, "read", 4))
281 if (!strncmp(cmd
, "write", 5))
283 #ifdef CONFIG_CMD_EEPROM_LAYOUT
284 if (!strncmp(cmd
, "print", 5))
286 if (!strncmp(cmd
, "update", 6))
287 return EEPROM_UPDATE
;
290 return EEPROM_ACTION_INVALID
;
293 static int eeprom_execute_command(enum eeprom_action action
, int i2c_bus
,
294 ulong i2c_addr
, int layout_ver
, char *key
,
295 char *value
, ulong addr
, ulong off
, ulong cnt
)
298 const char *const fmt
=
299 "\nEEPROM @0x%lX %s: addr %08lx off %04lx count %ld ... ";
300 #ifdef CONFIG_CMD_EEPROM_LAYOUT
301 struct eeprom_layout layout
;
304 if (action
== EEPROM_ACTION_INVALID
)
305 return CMD_RET_USAGE
;
307 eeprom_init(i2c_bus
);
308 if (action
== EEPROM_READ
) {
309 printf(fmt
, i2c_addr
, "read", addr
, off
, cnt
);
311 rcode
= eeprom_read(i2c_addr
, off
, (uchar
*)addr
, cnt
);
315 } else if (action
== EEPROM_WRITE
) {
316 printf(fmt
, i2c_addr
, "write", addr
, off
, cnt
);
318 rcode
= eeprom_write(i2c_addr
, off
, (uchar
*)addr
, cnt
);
324 #ifdef CONFIG_CMD_EEPROM_LAYOUT
325 rcode
= eeprom_read(i2c_addr
, 0, eeprom_buf
, CONFIG_SYS_EEPROM_SIZE
);
329 eeprom_layout_setup(&layout
, eeprom_buf
, CONFIG_SYS_EEPROM_SIZE
,
332 if (action
== EEPROM_PRINT
) {
333 layout
.print(&layout
);
337 layout
.update(&layout
, key
, value
);
339 rcode
= eeprom_write(i2c_addr
, 0, layout
.data
, CONFIG_SYS_EEPROM_SIZE
);
345 #define NEXT_PARAM(argc, index) { (argc)--; (index)++; }
346 int do_eeprom(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
348 int layout_ver
= LAYOUT_VERSION_AUTODETECT
;
349 enum eeprom_action action
= EEPROM_ACTION_INVALID
;
350 int i2c_bus
= -1, index
= 0;
351 ulong i2c_addr
= -1, addr
= 0, cnt
= 0, off
= 0;
353 char *field_name
= "";
354 char *field_value
= "";
357 return CMD_RET_USAGE
;
359 NEXT_PARAM(argc
, index
); /* Skip program name */
361 action
= parse_action(argv
[index
]);
362 NEXT_PARAM(argc
, index
);
364 if (action
== EEPROM_ACTION_INVALID
)
365 return CMD_RET_USAGE
;
367 #ifdef CONFIG_CMD_EEPROM_LAYOUT
368 if (action
== EEPROM_PRINT
|| action
== EEPROM_UPDATE
) {
369 if (!strcmp(argv
[index
], "-l")) {
370 NEXT_PARAM(argc
, index
);
371 layout_ver
= eeprom_parse_layout_version(argv
[index
]);
372 NEXT_PARAM(argc
, index
);
380 ret
= parse_i2c_bus_addr(&i2c_bus
, &i2c_addr
, argc
,
384 ret
= parse_i2c_bus_addr(&i2c_bus
, &i2c_addr
, argc
,
388 ret
= parse_i2c_bus_addr(&i2c_bus
, &i2c_addr
, argc
,
392 /* Get compiler to stop whining */
393 return CMD_RET_USAGE
;
396 if (ret
== CMD_RET_USAGE
)
400 NEXT_PARAM(argc
, index
);
402 if (action
== EEPROM_READ
|| action
== EEPROM_WRITE
) {
403 addr
= parse_numeric_param(argv
[index
]);
404 NEXT_PARAM(argc
, index
);
405 off
= parse_numeric_param(argv
[index
]);
406 NEXT_PARAM(argc
, index
);
407 cnt
= parse_numeric_param(argv
[index
]);
410 #ifdef CONFIG_CMD_EEPROM_LAYOUT
411 if (action
== EEPROM_UPDATE
) {
412 field_name
= argv
[index
];
413 NEXT_PARAM(argc
, index
);
414 field_value
= argv
[index
];
415 NEXT_PARAM(argc
, index
);
419 return eeprom_execute_command(action
, i2c_bus
, i2c_addr
, layout_ver
,
420 field_name
, field_value
, addr
, off
, cnt
);
424 eeprom
, 8, 1, do_eeprom
,
426 "read <bus> <devaddr> addr off cnt\n"
427 "eeprom write <bus> <devaddr> addr off cnt\n"
428 " - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
429 #ifdef CONFIG_CMD_EEPROM_LAYOUT
431 "eeprom print [-l <layout_version>] <bus> <devaddr>\n"
432 " - Print layout fields and their data in human readable format\n"
433 "eeprom update [-l <layout_version>] <bus> <devaddr> field_name field_value\n"
434 " - Update a specific eeprom field with new data.\n"
435 " The new data must be written in the same human readable format as shown by the print command.\n"
438 "The -l option can be used to force the command to interpret the EEPROM data using the chosen layout.\n"
439 "If the -l option is omitted, the command will auto detect the layout based on the data in the EEPROM.\n"
440 "The values which can be provided with the -l option are:\n"
441 CONFIG_EEPROM_LAYOUT_HELP_STRING
"\n"