Merge branch '2022-09-29-dm-core-support-multiple-device-trees-in-ofnode' into next
[platform/kernel/u-boot.git] / cmd / eeprom.c
index 0f2a9f7..fc0d444 100644 (file)
@@ -1,8 +1,7 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2000, 2001
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 /*
  * degradation (typical for EEPROM) is incured for FRAM memory:
  *
  * #define CONFIG_SYS_I2C_FRAM
- * #undef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
+ * Set CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS to 0
  *
  */
 
 #include <common.h>
 #include <config.h>
 #include <command.h>
+#include <eeprom.h>
 #include <i2c.h>
 #include <eeprom_layout.h>
-
-#ifndef        CONFIG_SYS_I2C_SPEED
-#define        CONFIG_SYS_I2C_SPEED    50000
-#endif
-
-#ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS
-#define CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS  0
-#endif
-
-#ifndef CONFIG_SYS_EEPROM_PAGE_WRITE_BITS
-#define CONFIG_SYS_EEPROM_PAGE_WRITE_BITS      8
-#endif
+#include <linux/delay.h>
 
 #ifndef        I2C_RXTX_LEN
 #define I2C_RXTX_LEN   128
 #define        EEPROM_PAGE_SIZE        (1 << CONFIG_SYS_EEPROM_PAGE_WRITE_BITS)
 #define        EEPROM_PAGE_OFFSET(x)   ((x) & (EEPROM_PAGE_SIZE - 1))
 
-/*
- * 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.
- */
-#if !defined(CONFIG_SPI) || defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
-#if !defined(CONFIG_SYS_I2C_EEPROM_ADDR_LEN) || \
-       (CONFIG_SYS_I2C_EEPROM_ADDR_LEN < 1) || \
-       (CONFIG_SYS_I2C_EEPROM_ADDR_LEN > 2)
-#error CONFIG_SYS_I2C_EEPROM_ADDR_LEN must be 1 or 2
-#endif
+#if CONFIG_IS_ENABLED(DM_I2C)
+static int eeprom_i2c_bus;
 #endif
 
 __weak int eeprom_write_enable(unsigned dev_addr, int state)
@@ -67,21 +45,23 @@ __weak int eeprom_write_enable(unsigned dev_addr, int state)
 
 void eeprom_init(int bus)
 {
-       /* SPI EEPROM */
-#if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
-       spi_init_f();
-#endif
-
        /* I2C EEPROM */
-#if defined(CONFIG_HARD_I2C) || defined(CONFIG_SYS_I2C)
-#if defined(CONFIG_SYS_I2C)
+#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);
-#endif
        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;
@@ -110,7 +90,7 @@ static int eeprom_len(unsigned offset, unsigned end)
 
        /*
         * For a FRAM device there is no limit on the number of the
-        * bytes that can be ccessed with the single read or write
+        * bytes that can be accessed with the single read or write
         * operation.
         */
 #if !defined(CONFIG_SYS_I2C_FRAM)
@@ -132,26 +112,32 @@ static int eeprom_rw_block(unsigned offset, uchar *addr, unsigned alen,
 {
        int ret = 0;
 
-       /* SPI */
-#if defined(CONFIG_SPI) && !defined(CONFIG_ENV_EEPROM_IS_ON_I2C)
+#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)
-               spi_read(addr, alen, buffer, len);
+               ret = dm_i2c_read(dev, offset, buffer, len);
        else
-               spi_write(addr, alen, buffer, len);
-#else  /* I2C */
+               ret = dm_i2c_write(dev, offset, buffer, len);
 
-#if defined(CONFIG_SYS_I2C_EEPROM_BUS)
-       i2c_set_bus_num(CONFIG_SYS_I2C_EEPROM_BUS);
-#endif
+#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 = 1;
-#endif
+               ret = CMD_RET_FAILURE;
+
        return ret;
 }
 
@@ -163,6 +149,10 @@ static int eeprom_rw(unsigned dev_addr, unsigned offset, uchar *buffer,
        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);
 
@@ -173,8 +163,10 @@ static int eeprom_rw(unsigned dev_addr, unsigned offset, uchar *buffer,
                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;
@@ -228,15 +220,15 @@ static int parse_numeric_param(char *str)
  * @returns:   number of arguments parsed or CMD_RET_USAGE if error
  */
 static int parse_i2c_bus_addr(int *i2c_bus, ulong *i2c_addr, int argc,
-                             char * const argv[], int argc_no_bus_addr)
+                             char *const argv[], int argc_no_bus_addr)
 {
        int argc_no_bus = argc_no_bus_addr + 1;
        int argc_bus_addr = argc_no_bus_addr + 2;
 
-#ifdef CONFIG_SYS_DEF_EEPROM_ADDR
+#ifdef CONFIG_SYS_I2C_EEPROM_ADDR
        if (argc == argc_no_bus_addr) {
                *i2c_bus = -1;
-               *i2c_addr = CONFIG_SYS_DEF_EEPROM_ADDR;
+               *i2c_addr = CONFIG_SYS_I2C_EEPROM_ADDR;
 
                return 0;
        }
@@ -267,10 +259,6 @@ __weak int eeprom_parse_layout_version(char *str)
 
 static unsigned char eeprom_buf[CONFIG_SYS_EEPROM_SIZE];
 
-#ifndef CONFIG_EEPROM_LAYOUT_HELP_STRING
-#define CONFIG_EEPROM_LAYOUT_HELP_STRING "<not defined>"
-#endif
-
 #endif
 
 enum eeprom_action {
@@ -281,17 +269,21 @@ enum eeprom_action {
        EEPROM_ACTION_INVALID,
 };
 
-#ifdef CONFIG_CMD_EEPROM_LAYOUT
 static enum eeprom_action parse_action(char *cmd)
 {
+       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;
 }
-#endif
 
 static int eeprom_execute_command(enum eeprom_action action, int i2c_bus,
                                  ulong i2c_addr, int layout_ver, char *key,
@@ -299,7 +291,7 @@ static int eeprom_execute_command(enum eeprom_action action, int i2c_bus,
 {
        int rcode = 0;
        const char *const fmt =
-               "\nEEPROM @0x%lX %s: addr %08lx  off %04lx  count %ld ... ";
+               "\nEEPROM @0x%lX %s: addr 0x%08lx  off 0x%04lx  count %ld ... ";
 #ifdef CONFIG_CMD_EEPROM_LAYOUT
        struct eeprom_layout layout;
 #endif
@@ -345,14 +337,14 @@ static int eeprom_execute_command(enum eeprom_action action, int i2c_bus,
        return rcode;
 }
 
-#ifdef CONFIG_CMD_EEPROM_LAYOUT
 #define NEXT_PARAM(argc, index)        { (argc)--; (index)++; }
-static int do_eeprom_layout(cmd_tbl_t *cmdtp, int flag, int argc,
-                           char * const argv[])
+int do_eeprom(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
 {
        int layout_ver = LAYOUT_VERSION_AUTODETECT;
        enum eeprom_action action = EEPROM_ACTION_INVALID;
-       int i2c_bus = -1, i2c_addr = -1, index = 0;
+       int i2c_bus = -1, index = 0;
+       ulong i2c_addr = -1, addr = 0, cnt = 0, off = 0;
+       int ret;
        char *field_name = "";
        char *field_value = "";
 
@@ -364,78 +356,63 @@ static int do_eeprom_layout(cmd_tbl_t *cmdtp, int flag, int argc,
        action = parse_action(argv[index]);
        NEXT_PARAM(argc, index);
 
-       if (argc <= 1)
+       if (action == EEPROM_ACTION_INVALID)
                return CMD_RET_USAGE;
 
-       if (!strcmp(argv[index], "-l")) {
-               NEXT_PARAM(argc, index);
-
-               layout_ver = eeprom_parse_layout_version(argv[index]);
-               NEXT_PARAM(argc, index);
+#ifdef CONFIG_CMD_EEPROM_LAYOUT
+       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
 
-       if (argc <= 1)
+       switch (action) {
+       case EEPROM_READ:
+       case EEPROM_WRITE:
+               ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
+                                        argv + index, 3);
+               break;
+       case EEPROM_PRINT:
+               ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
+                                        argv + index, 0);
+               break;
+       case EEPROM_UPDATE:
+               ret = parse_i2c_bus_addr(&i2c_bus, &i2c_addr, argc,
+                                        argv + index, 2);
+               break;
+       default:
+               /* Get compiler to stop whining */
                return CMD_RET_USAGE;
+       }
 
-       i2c_bus = parse_numeric_param(argv[index]);
-       NEXT_PARAM(argc, index);
-
-       i2c_addr = parse_numeric_param(argv[index]);
-       NEXT_PARAM(argc, index);
-
-       if (action == EEPROM_PRINT)
-               goto done;
+       if (ret == CMD_RET_USAGE)
+               return ret;
 
-       if (argc) {
-               field_name = argv[index];
+       while (ret--)
                NEXT_PARAM(argc, index);
-       }
 
-       if (argc) {
-               field_value = argv[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]);
        }
 
-done:
-       return eeprom_execute_command(action, i2c_bus, i2c_addr, layout_ver,
-                                     field_name, field_value, 0, 0, 0);
-}
-
-#endif
-
-static int do_eeprom(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
-{
-       char * const *args = &argv[2];
-       int rcode;
-       ulong dev_addr, addr, off, cnt;
-       int bus_addr;
-
 #ifdef CONFIG_CMD_EEPROM_LAYOUT
-       if (argc >= 2) {
-               if (!strcmp(argv[1], "update") || !strcmp(argv[1], "print"))
-                       return do_eeprom_layout(cmdtp, flag, argc, argv);
+       if (action == EEPROM_UPDATE) {
+               field_name = argv[index];
+               NEXT_PARAM(argc, index);
+               field_value = argv[index];
+               NEXT_PARAM(argc, index);
        }
 #endif
 
-       rcode = parse_i2c_bus_addr(&bus_addr, &dev_addr, argc - 2, argv + 2, 3);
-       if (rcode == CMD_RET_USAGE)
-               return rcode;
-
-       addr = simple_strtoul(*args++, NULL, 16);
-       off = simple_strtoul(*args++, NULL, 16);
-       cnt = simple_strtoul(*args++, NULL, 16);
-
-       if (strcmp(argv[1], "read") == 0) {
-               return eeprom_execute_command(EEPROM_READ, bus_addr, dev_addr,
-                                             LAYOUT_VERSION_UNRECOGNIZED,
-                                             NULL, NULL, addr, off, cnt);
-       } else if (strcmp(argv[1], "write") == 0) {
-               return eeprom_execute_command(EEPROM_WRITE, bus_addr, dev_addr,
-                                             LAYOUT_VERSION_UNRECOGNIZED,
-                                             NULL, NULL, addr, off, cnt);
-       }
-
-       return CMD_RET_USAGE;
+       return eeprom_execute_command(action, i2c_bus, i2c_addr, layout_ver,
+                                     field_name, field_value, addr, off, cnt);
 }
 
 U_BOOT_CMD(
@@ -446,9 +423,9 @@ U_BOOT_CMD(
        "       - read/write `cnt' bytes from `devaddr` EEPROM at offset `off'"
 #ifdef CONFIG_CMD_EEPROM_LAYOUT
        "\n"
-       "eeprom print [-l <layout_version>] bus devaddr\n"
+       "eeprom print [-l <layout_version>] <bus> <devaddr>\n"
        "       - Print layout fields and their data in human readable format\n"
-       "eeprom update [-l <layout_version>] bus devaddr <field_name> <field_value>\n"
+       "eeprom update [-l <layout_version>] <bus> <devaddr> 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.\n"
        "\n"