cmd/eeprom.c

   1 /*
   2  * (C) Copyright 2000, 2001
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 /*
   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.
  14  *
  15  * Use the following configuration options to ensure no unneeded performance
  16  * degradation (typical for EEPROM) is incured for FRAM memory:
  17  *
  18  * #define CONFIG_SYS_I2C_FRAM
  19  * #undef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
  20  *
  21  */
  22
  23 #include <common.h>
  24 #include <config.h>
  25 #include <command.h>
  26 #include <i2c.h>
  27
  28 #ifndef CONFIG_SYS_I2C_SPEED
  29 #define CONFIG_SYS_I2C_SPEED    50000
  30 #endif
  31
  32 #ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
  33 #define CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS   0
  34 #endif
  35
  36 #ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_BITS
  37 #define CONFIG_SYS_EEPROM_PAGE_WRITE_BITS       8
  38 #endif
  39
  40 #ifndef I2C_RXTX_LEN
  41 #define I2C_RXTX_LEN    128
  42 #endif
  43
  44 #define EEPROM_PAGE_SIZE        (1 << CONFIG_SYS_EEPROM_PAGE_WRITE_BITS)
  45 #define EEPROM_PAGE_OFFSET(x)   ((x) & (EEPROM_PAGE_SIZE - 1))
  46
  47 /*
  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.
  50  *
  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.
  53  */
  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
  59 #endif
  60 #endif
  61
  62 __weak int eeprom_write_enable(unsigned dev_addr, int state)
  63 {
  64         return 0;
  65 }
  66
  67 void eeprom_init(int bus)
  68 {
  69         /* SPI EEPROM */
  70 #if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
  71         spi_init_f();
  72 #endif
  73
  74         /* I2C EEPROM */
  75 #if defined(CONFIG_HARD_I2C) || defined(CONFIG_SYS_I2C)
  76 #if defined(CONFIG_SYS_I2C)
  77         if (bus >= 0)
  78                 i2c_set_bus_num(bus);
  79 #endif
  80         i2c_init(CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
  81 #endif
  82 }
  83
  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
 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
 112          * bytes that can be ccessed with the single read or write
 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
 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
 134         /* SPI */
 135 #if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
 136         if (read)
 137                 spi_read(addr, alen, buffer, len);
 138         else
 139                 spi_write(addr, alen, buffer, len);
 140 #else   /* I2C */
 141
 142 #if defined(CONFIG_SYS_I2C_EEPROM_BUS)
 143         i2c_set_bus_num(CONFIG_SYS_I2C_EEPROM_BUS);
 144 #endif
 145
 146         if (read)
 147                 ret = i2c_read(addr[0], offset, alen - 1, buffer, len);
 148         else
 149                 ret = i2c_write(addr[0], offset, alen - 1, buffer, len);
 150
 151         if (ret)
 152                 ret = 1;
 153 #endif
 154         return ret;
 155 }
 156
 157 static int eeprom_rw(unsigned dev_addr, unsigned offset, uchar *buffer,
 158                      unsigned cnt, bool read)
 159 {
 160         unsigned end = offset + cnt;
 161         unsigned alen, len;
 162         int rcode = 0;
 163         uchar addr[3];
 164
 165         while (offset < end) {
 166                 alen = eeprom_addr(dev_addr, offset, addr);
 167
 168                 len = eeprom_len(offset, end);
 169
 170                 rcode = eeprom_rw_block(offset, addr, alen, buffer, len, read);
 171
 172                 buffer += len;
 173                 offset += len;
 174
 175                 if (!read)
 176                         udelay(CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS * 1000);
 177         }
 178
 179         return rcode;
 180 }
 181
 182 int eeprom_read(unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt)
 183 {
 184         /*
 185          * Read data until done or would cross a page boundary.
 186          * We must write the address again when changing pages
 187          * because the next page may be in a different device.
 188          */
 189         return eeprom_rw(dev_addr, offset, buffer, cnt, 1);
 190 }
 191
 192 int eeprom_write(unsigned dev_addr, unsigned offset,
 193                  uchar *buffer, unsigned cnt)
 194 {
 195         int ret;
 196
 197         eeprom_write_enable(dev_addr, 1);
 198
 199         /*
 200          * Write data until done or would cross a write page boundary.
 201          * We must write the address again when changing pages
 202          * because the address counter only increments within a page.
 203          */
 204         ret = eeprom_rw(dev_addr, offset, buffer, cnt, 0);
 205
 206         eeprom_write_enable(dev_addr, 0);
 207         return ret;
 208 }
 209
 210 static int parse_numeric_param(char *str)
 211 {
 212         char *endptr;
 213         int value = simple_strtol(str, &endptr, 16);
 214
 215         return (*endptr != '\0') ? -1 : value;
 216 }
 217
 218 /**
 219  * parse_i2c_bus_addr - parse the i2c bus and i2c devaddr parameters
 220  *
 221  * @i2c_bus:    address to store the i2c bus
 222  * @i2c_addr:   address to store the device i2c address
 223  * @argc:       count of command line arguments left to parse
 224  * @argv:       command line arguments left to parse
 225  * @argc_no_bus_addr:   argc value we expect to see when bus & addr aren't given
 226  *
 227  * @returns:    number of arguments parsed or CMD_RET_USAGE if error
 228  */
 229 static int parse_i2c_bus_addr(int *i2c_bus, ulong *i2c_addr, int argc,
 230                               char * const argv[], int argc_no_bus_addr)
 231 {
 232         int argc_no_bus = argc_no_bus_addr + 1;
 233         int argc_bus_addr = argc_no_bus_addr + 2;
 234
 235 #ifdef CONFIG_SYS_DEF_EEPROM_ADDR
 236         if (argc == argc_no_bus_addr) {
 237                 *i2c_bus = -1;
 238                 *i2c_addr = CONFIG_SYS_DEF_EEPROM_ADDR;
 239
 240                 return 0;
 241         }
 242 #endif
 243         if (argc == argc_no_bus) {
 244                 *i2c_bus = -1;
 245                 *i2c_addr = parse_numeric_param(argv[0]);
 246
 247                 return 1;
 248         }
 249
 250         if (argc == argc_bus_addr) {
 251                 *i2c_bus = parse_numeric_param(argv[0]);
 252                 *i2c_addr = parse_numeric_param(argv[1]);
 253
 254                 return 2;
 255         }
 256
 257         return CMD_RET_USAGE;
 258 }
 259
 260 #ifdef CONFIG_CMD_EEPROM_LAYOUT
 261 #include <eeprom_layout.h>
 262
 263 __weak int eeprom_parse_layout_version(char *str)
 264 {
 265         return LAYOUT_VERSION_UNRECOGNIZED;
 266 }
 267
 268 static unsigned char eeprom_buf[CONFIG_SYS_EEPROM_SIZE];
 269
 270 #ifndef CONFIG_EEPROM_LAYOUT_HELP_STRING
 271 #define CONFIG_EEPROM_LAYOUT_HELP_STRING "<not defined>"
 272 #endif
 273
 274 enum eeprom_action {
 275         EEPROM_PRINT,
 276         EEPROM_UPDATE,
 277         EEPROM_ACTION_INVALID,
 278 };
 279
 280 static enum eeprom_action parse_action(char *cmd)
 281 {
 282         if (!strncmp(cmd, "print", 5))
 283                 return EEPROM_PRINT;
 284         if (!strncmp(cmd, "update", 6))
 285                 return EEPROM_UPDATE;
 286
 287         return EEPROM_ACTION_INVALID;
 288 }
 289
 290 static int eeprom_execute_command(enum eeprom_action action, int i2c_bus,
 291                                   int i2c_addr, int layout_ver, char *key,
 292                                   char *value)
 293 {
 294         int rcode;
 295         struct eeprom_layout layout;
 296
 297         if (action == EEPROM_ACTION_INVALID)
 298                 return CMD_RET_USAGE;
 299
 300         eeprom_init(i2c_bus);
 301         rcode = eeprom_read(i2c_addr, 0, eeprom_buf, CONFIG_SYS_EEPROM_SIZE);
 302         if (rcode < 0)
 303                 return rcode;
 304
 305         eeprom_layout_setup(&layout, eeprom_buf, CONFIG_SYS_EEPROM_SIZE,
 306                             layout_ver);
 307
 308         if (action == EEPROM_PRINT) {
 309                 layout.print(&layout);
 310                 return 0;
 311         }
 312
 313         layout.update(&layout, key, value);
 314
 315         rcode = eeprom_write(i2c_addr, 0, layout.data, CONFIG_SYS_EEPROM_SIZE);
 316
 317         return rcode;
 318 }
 319
 320 #define NEXT_PARAM(argc, index) { (argc)--; (index)++; }
 321 static int do_eeprom_layout(cmd_tbl_t *cmdtp, int flag, int argc,
 322                             char * const argv[])
 323 {
 324         int layout_ver = LAYOUT_VERSION_AUTODETECT;
 325         enum eeprom_action action = EEPROM_ACTION_INVALID;
 326         int i2c_bus = -1, i2c_addr = -1, index = 0;
 327         char *field_name = "";
 328         char *field_value = "";
 329
 330         if (argc <= 1)
 331                 return CMD_RET_USAGE;
 332
 333         NEXT_PARAM(argc, index); /* Skip program name */
 334
 335         action = parse_action(argv[index]);
 336         NEXT_PARAM(argc, index);
 337
 338         if (argc <= 1)
 339                 return CMD_RET_USAGE;
 340
 341         if (!strcmp(argv[index], "-l")) {
 342                 NEXT_PARAM(argc, index);
 343
 344                 layout_ver = eeprom_parse_layout_version(argv[index]);
 345                 NEXT_PARAM(argc, index);
 346         }
 347
 348         if (argc <= 1)
 349                 return CMD_RET_USAGE;
 350
 351         i2c_bus = parse_numeric_param(argv[index]);
 352         NEXT_PARAM(argc, index);
 353
 354         i2c_addr = parse_numeric_param(argv[index]);
 355         NEXT_PARAM(argc, index);
 356
 357         if (action == EEPROM_PRINT)
 358                 goto done;
 359
 360         if (argc) {
 361                 field_name = argv[index];
 362                 NEXT_PARAM(argc, index);
 363         }
 364
 365         if (argc) {
 366                 field_value = argv[index];
 367                 NEXT_PARAM(argc, index);
 368         }
 369
 370 done:
 371         return eeprom_execute_command(action, i2c_bus, i2c_addr, layout_ver,
 372                                field_name, field_value);
 373 }
 374
 375 #endif
 376
 377 static int do_eeprom(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 378 {
 379         const char *const fmt =
 380                 "\nEEPROM @0x%lX %s: addr %08lx  off %04lx  count %ld ... ";
 381         char * const *args = &argv[2];
 382         int rcode;
 383         ulong dev_addr, addr, off, cnt;
 384         int bus_addr;
 385
 386 #ifdef CONFIG_CMD_EEPROM_LAYOUT
 387         if (argc >= 2) {
 388                 if (!strcmp(argv[1], "update") || !strcmp(argv[1], "print"))
 389                         return do_eeprom_layout(cmdtp, flag, argc, argv);
 390         }
 391 #endif
 392
 393         rcode = parse_i2c_bus_addr(&bus_addr, &dev_addr, argc - 2, argv + 2, 3);
 394         if (rcode == CMD_RET_USAGE)
 395                 return rcode;
 396
 397         addr = simple_strtoul(*args++, NULL, 16);
 398         off = simple_strtoul(*args++, NULL, 16);
 399         cnt = simple_strtoul(*args++, NULL, 16);
 400
 401         eeprom_init(bus_addr);
 402
 403         if (strcmp(argv[1], "read") == 0) {
 404                 printf(fmt, dev_addr, argv[1], addr, off, cnt);
 405
 406                 rcode = eeprom_read(dev_addr, off, (uchar *)addr, cnt);
 407
 408                 puts("done\n");
 409                 return rcode;
 410         } else if (strcmp(argv[1], "write") == 0) {
 411                 printf(fmt, dev_addr, argv[1], addr, off, cnt);
 412
 413                 rcode = eeprom_write(dev_addr, off, (uchar *)addr, cnt);
 414
 415                 puts("done\n");
 416                 return rcode;
 417         }
 418
 419         return CMD_RET_USAGE;
 420 }
 421
 422 U_BOOT_CMD(
 423         eeprom, 8,      1,      do_eeprom,
 424         "EEPROM sub-system",
 425         "read  <bus> <devaddr> addr off cnt\n"
 426         "eeprom write <bus> <devaddr> addr off cnt\n"
 427         "       - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
 428 #ifdef CONFIG_CMD_EEPROM_LAYOUT
 429         "\n"
 430         "eeprom print [-l <layout_version>] bus devaddr\n"
 431         "       - Print layout fields and their data in human readable format\n"
 432         "eeprom update [-l <layout_version>] bus devaddr <field_name> <field_value>\n"
 433         "       - Update a specific eeprom field with new data.\n"
 434         "         The new data must be written in the same human readable format as shown by the print command.\n"
 435         "\n"
 436         "LAYOUT VERSIONS\n"
 437         "The -l option can be used to force the command to interpret the EEPROM data using the chosen layout.\n"
 438         "If the -l option is omitted, the command will auto detect the layout based on the data in the EEPROM.\n"
 439         "The values which can be provided with the -l option are:\n"
 440         CONFIG_EEPROM_LAYOUT_HELP_STRING"\n"
 441 #endif
 442 )