toradex: tdx-cfg-block: add support for EEPROM
authorIgor Opaniuk <igor.opaniuk@toradex.com>
Wed, 15 Jul 2020 10:30:55 +0000 (13:30 +0300)
committerStefano Babic <sbabic@denx.de>
Mon, 27 Jul 2020 12:00:36 +0000 (14:00 +0200)
This introduces support for EEPROM as a storage for the main Toradex
config block and additional config blocks on extra EEPROM chips (on
carrier board or video adapters).

To enable EEPROM as a storage for the main config block:
TDX_HAVE_EEPROM=y.

For additional EEPROMs please enable this Kconfig symbol:
TDX_CFG_BLOCK_EXTRA=y.

Information about existing EEPROM chips is provided via Device Tree
using aliases.

You can also write configuration for the carrier board using
create_carrier subcommand for cfgblock. Example:

Verdin iMX8MM # cfgblock create_carrier
Supported carrier boards:
UNKNOWN CARRIER                     = [0]
Verdin Carrier Board                = [1]
Choose your carrier board (provide ID): 1
Enter carrier board version (e.g. V1.1B): V1.0A
Enter carrier board serial number: 10622780

Also with barcode:
Verdin iMX8MM # cfgblock create carrier -y 0156100010622780

Signed-off-by: Igor Opaniuk <igor.opaniuk@toradex.com>
board/toradex/common/Kconfig
board/toradex/common/tdx-cfg-block.c
board/toradex/common/tdx-cfg-block.h

index 11f4aab..36068d2 100644 (file)
@@ -20,6 +20,12 @@ config TDX_HAVE_NAND
 config TDX_HAVE_NOR
        bool
 
+config TDX_HAVE_EEPROM
+       bool
+
+config TDX_HAVE_EEPROM_EXTRA
+       bool
+
 if TDX_CFG_BLOCK
 
 config TDX_CFG_BLOCK_IS_IN_MMC
@@ -37,6 +43,11 @@ config TDX_CFG_BLOCK_IS_IN_NOR
        depends on TDX_HAVE_NOR
        default y
 
+config TDX_CFG_BLOCK_IS_IN_EEPROM
+       bool
+       depends on TDX_HAVE_EEPROM
+       default y
+
 config TDX_CFG_BLOCK_DEV
        int "Toradex config block eMMC device ID"
        depends on TDX_CFG_BLOCK_IS_IN_MMC
@@ -66,4 +77,11 @@ config TDX_CFG_BLOCK_2ND_ETHADDR
          Ethernet carrier boards. This options enables the code to set the
          second Ethernet address as environment variable (eth1addr).
 
+config TDX_CFG_BLOCK_EXTRA
+       bool "Support for additional EEPROMs (carrier board, display adapter)"
+       depends on TDX_HAVE_EEPROM_EXTRA
+       help
+         Enables fetching auxilary config blocks from carrier board/display
+         adapter EEPROMs.
+
 endif
index adf6721..5162ed4 100644 (file)
@@ -5,6 +5,8 @@
 
 #include <common.h>
 #include "tdx-cfg-block.h"
+#include "tdx-eeprom.h"
+
 #include <command.h>
 #include <asm/cache.h>
 
@@ -37,21 +39,31 @@ DECLARE_GLOBAL_DATA_PTR;
 
 #define TAG_VALID      0xcf01
 #define TAG_MAC                0x0000
+#define TAG_CAR_SERIAL 0x0021
 #define TAG_HW         0x0008
 #define TAG_INVALID    0xffff
 
 #define TAG_FLAG_VALID 0x1
 
+#define TDX_EEPROM_ID_MODULE           0
+#define TDX_EEPROM_ID_CARRIER          1
+
 #if defined(CONFIG_TDX_CFG_BLOCK_IS_IN_MMC)
 #define TDX_CFG_BLOCK_MAX_SIZE 512
 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NAND)
 #define TDX_CFG_BLOCK_MAX_SIZE 64
 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NOR)
 #define TDX_CFG_BLOCK_MAX_SIZE 64
+#elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_EEPROM)
+#define TDX_CFG_BLOCK_MAX_SIZE 64
 #else
 #error Toradex config block location not set
 #endif
 
+#ifdef CONFIG_TDX_CFG_BLOCK_EXTRA
+#define TDX_CFG_BLOCK_EXTRA_MAX_SIZE 64
+#endif
+
 struct toradex_tag {
        u32 len:14;
        u32 flags:2;
@@ -62,6 +74,11 @@ bool valid_cfgblock;
 struct toradex_hw tdx_hw_tag;
 struct toradex_eth_addr tdx_eth_addr;
 u32 tdx_serial;
+#ifdef CONFIG_TDX_CFG_BLOCK_EXTRA
+u32 tdx_car_serial;
+bool valid_cfgblock_carrier;
+struct toradex_hw tdx_car_hw_tag;
+#endif
 
 const char * const toradex_modules[] = {
         [0] = "UNKNOWN MODULE",
@@ -236,6 +253,20 @@ static int write_tdx_cfg_block_to_nor(unsigned char *config_block)
 }
 #endif
 
+#ifdef CONFIG_TDX_CFG_BLOCK_IS_IN_EEPROM
+static int read_tdx_cfg_block_from_eeprom(unsigned char *config_block)
+{
+       return read_tdx_eeprom_data(TDX_EEPROM_ID_MODULE, 0x0, config_block,
+                                   TDX_CFG_BLOCK_MAX_SIZE);
+}
+
+static int write_tdx_cfg_block_to_eeprom(unsigned char *config_block)
+{
+       return write_tdx_eeprom_data(TDX_EEPROM_ID_MODULE, 0x0, config_block,
+                                    TDX_CFG_BLOCK_MAX_SIZE);
+}
+#endif
+
 int read_tdx_cfg_block(void)
 {
        int ret = 0;
@@ -259,6 +290,8 @@ int read_tdx_cfg_block(void)
        ret = read_tdx_cfg_block_from_nand(config_block);
 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NOR)
        ret = read_tdx_cfg_block_from_nor(config_block);
+#elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_EEPROM)
+       ret = read_tdx_cfg_block_from_eeprom(config_block);
 #else
        ret = -EINVAL;
 #endif
@@ -275,7 +308,12 @@ int read_tdx_cfg_block(void)
        valid_cfgblock = true;
        offset = 4;
 
-       while (offset < TDX_CFG_BLOCK_MAX_SIZE) {
+       /*
+        * check if there is enough space for storing tag and value of the
+        * biggest element
+        */
+       while (offset + sizeof(struct toradex_tag) +
+              sizeof(struct toradex_hw) < TDX_CFG_BLOCK_MAX_SIZE) {
                tag = (struct toradex_tag *)(config_block + offset);
                offset += 4;
                if (tag->id == TAG_INVALID)
@@ -334,7 +372,6 @@ static int get_cfgblock_interactive(void)
                it = 'y';
 #endif
 
-
 #if defined(CONFIG_TARGET_APALIS_IMX8) || \
                defined(CONFIG_TARGET_APALIS_IMX8X) || \
                defined(CONFIG_TARGET_COLIBRI_IMX6ULL) || \
@@ -505,7 +542,8 @@ static int get_cfgblock_interactive(void)
        return 0;
 }
 
-static int get_cfgblock_barcode(char *barcode)
+static int get_cfgblock_barcode(char *barcode, struct toradex_hw *tag,
+                               u32 *serial)
 {
        if (strlen(barcode) < 16) {
                printf("Argument too short, barcode is 16 chars long\n");
@@ -513,31 +551,154 @@ static int get_cfgblock_barcode(char *barcode)
        }
 
        /* Get hardware information from the first 8 digits */
-       tdx_hw_tag.ver_major = barcode[4] - '0';
-       tdx_hw_tag.ver_minor = barcode[5] - '0';
-       tdx_hw_tag.ver_assembly = barcode[7] - '0';
+       tag->ver_major = barcode[4] - '0';
+       tag->ver_minor = barcode[5] - '0';
+       tag->ver_assembly = barcode[7] - '0';
 
        barcode[4] = '\0';
-       tdx_hw_tag.prodid = simple_strtoul(barcode, NULL, 10);
+       tag->prodid = simple_strtoul(barcode, NULL, 10);
 
        /* Parse second part of the barcode (serial number */
        barcode += 8;
-       tdx_serial = simple_strtoul(barcode, NULL, 10);
+       *serial = simple_strtoul(barcode, NULL, 10);
 
        return 0;
 }
 
-static int do_cfgblock_create(struct cmd_tbl *cmdtp, int flag, int argc,
-                             char *const argv[])
+static int write_tag(u8 *config_block, int *offset, int tag_id,
+                    u8 *tag_data, size_t tag_data_size)
 {
-       u8 *config_block;
        struct toradex_tag *tag;
-       size_t size = TDX_CFG_BLOCK_MAX_SIZE;
+
+       if (!offset || !config_block)
+               return -EINVAL;
+
+       tag = (struct toradex_tag *)(config_block + *offset);
+       tag->id = tag_id;
+       tag->flags = TAG_FLAG_VALID;
+       /* len is provided as number of 32bit values after the tag */
+       tag->len = (tag_data_size + sizeof(u32) - 1) / sizeof(u32);
+       *offset += sizeof(struct toradex_tag);
+       if (tag_data && tag_data_size) {
+               memcpy(config_block + *offset, tag_data,
+                      tag_data_size);
+               *offset += tag_data_size;
+       }
+
+       return 0;
+}
+
+#ifdef CONFIG_TDX_CFG_BLOCK_EXTRA
+int read_tdx_cfg_block_carrier(void)
+{
+       int ret = 0;
+       u8 *config_block = NULL;
+       struct toradex_tag *tag;
+       size_t size = TDX_CFG_BLOCK_EXTRA_MAX_SIZE;
+       int offset;
+
+       /* Allocate RAM area for carrier config block */
+       config_block = memalign(ARCH_DMA_MINALIGN, size);
+       if (!config_block) {
+               printf("Not enough malloc space available!\n");
+               return -ENOMEM;
+       }
+
+       memset(config_block, 0, size);
+
+       ret = read_tdx_eeprom_data(TDX_EEPROM_ID_CARRIER, 0x0, config_block,
+                                  size);
+       if (ret)
+               return ret;
+
+       /* Expect a valid tag first */
+       tag = (struct toradex_tag *)config_block;
+       if (tag->flags != TAG_FLAG_VALID || tag->id != TAG_VALID) {
+               valid_cfgblock_carrier = false;
+               ret = -EINVAL;
+               goto out;
+       }
+       valid_cfgblock_carrier = true;
+       offset = 4;
+
+       while (offset + sizeof(struct toradex_tag) +
+              sizeof(struct toradex_hw) < TDX_CFG_BLOCK_MAX_SIZE) {
+               tag = (struct toradex_tag *)(config_block + offset);
+               offset += 4;
+               if (tag->id == TAG_INVALID)
+                       break;
+
+               if (tag->flags == TAG_FLAG_VALID) {
+                       switch (tag->id) {
+                       case TAG_CAR_SERIAL:
+                               memcpy(&tdx_car_serial, config_block + offset,
+                                      sizeof(tdx_car_serial));
+                               break;
+                       case TAG_HW:
+                               memcpy(&tdx_car_hw_tag, config_block +
+                                      offset, 8);
+                               break;
+                       }
+               }
+
+               /* Get to next tag according to current tags length */
+               offset += tag->len * 4;
+       }
+out:
+       free(config_block);
+       return ret;
+}
+
+static int get_cfgblock_carrier_interactive(void)
+{
+       char message[CONFIG_SYS_CBSIZE];
+       int len;
+
+       printf("Supported carrier boards:\n");
+       printf("CARRIER BOARD NAME\t\t [ID]\n");
+       for (int i = 0; i < sizeof(toradex_carrier_boards) /
+                           sizeof(toradex_carrier_boards[0]); i++)
+               if (toradex_carrier_boards[i])
+                       printf("%s \t\t [%d]\n", toradex_carrier_boards[i], i);
+
+       sprintf(message, "Choose your carrier board (provide ID): ");
+       len = cli_readline(message);
+       tdx_car_hw_tag.prodid = simple_strtoul(console_buffer, NULL, 10);
+
+       do {
+               sprintf(message, "Enter carrier board version (e.g. V1.1B): V");
+               len = cli_readline(message);
+       } while (len < 4);
+
+       tdx_car_hw_tag.ver_major = console_buffer[0] - '0';
+       tdx_car_hw_tag.ver_minor = console_buffer[2] - '0';
+       tdx_car_hw_tag.ver_assembly = console_buffer[3] - 'A';
+
+       while (len < 8) {
+               sprintf(message, "Enter carrier board serial number: ");
+               len = cli_readline(message);
+       }
+
+       tdx_car_serial = simple_strtoul(console_buffer, NULL, 10);
+
+       return 0;
+}
+
+static int do_cfgblock_carrier_create(struct cmd_tbl *cmdtp, int flag, int argc,
+                                     char * const argv[])
+{
+       u8 *config_block;
+       size_t size = TDX_CFG_BLOCK_EXTRA_MAX_SIZE;
        int offset = 0;
        int ret = CMD_RET_SUCCESS;
        int err;
        int force_overwrite = 0;
 
+       if (argc >= 3) {
+               if (argv[2][0] == '-' && argv[2][1] == 'y')
+                       force_overwrite = 1;
+       }
+
        /* Allocate RAM area for config block */
        config_block = memalign(ARCH_DMA_MINALIGN, size);
        if (!config_block) {
@@ -546,12 +707,95 @@ static int do_cfgblock_create(struct cmd_tbl *cmdtp, int flag, int argc,
        }
 
        memset(config_block, 0xff, size);
+       read_tdx_cfg_block_carrier();
+       if (valid_cfgblock_carrier && !force_overwrite) {
+               char message[CONFIG_SYS_CBSIZE];
+
+               sprintf(message, "A valid Toradex Carrier config block is present, still recreate? [y/N] ");
+
+               if (!cli_readline(message))
+                       goto out;
+
+               if (console_buffer[0] != 'y' &&
+                   console_buffer[0] != 'Y')
+                       goto out;
+       }
+
+       if (argc < 3 || (force_overwrite && argc < 4)) {
+               err = get_cfgblock_carrier_interactive();
+       } else {
+               if (force_overwrite)
+                       err = get_cfgblock_barcode(argv[3], &tdx_car_hw_tag,
+                                                  &tdx_car_serial);
+               else
+                       err = get_cfgblock_barcode(argv[2], &tdx_car_hw_tag,
+                                                  &tdx_car_serial);
+       }
+
+       if (err) {
+               ret = CMD_RET_FAILURE;
+               goto out;
+       }
+
+       /* Valid Tag */
+       write_tag(config_block, &offset, TAG_VALID, NULL, 0);
+
+       /* Product Tag */
+       write_tag(config_block, &offset, TAG_HW, (u8 *)&tdx_car_hw_tag,
+                 sizeof(tdx_car_hw_tag));
+
+       /* Serial Tag */
+       write_tag(config_block, &offset, TAG_CAR_SERIAL, (u8 *)&tdx_car_serial,
+                 sizeof(tdx_car_serial));
+
+       memset(config_block + offset, 0, 32 - offset);
+       err = write_tdx_eeprom_data(TDX_EEPROM_ID_CARRIER, 0x0, config_block,
+                                   size);
+       if (err) {
+               printf("Failed to write Toradex Extra config block: %d\n",
+                      ret);
+               ret = CMD_RET_FAILURE;
+               goto out;
+       }
+
+       printf("Toradex Extra config block successfully written\n");
+
+out:
+       free(config_block);
+       return ret;
+}
+
+#endif /* CONFIG_TDX_CFG_BLOCK_EXTRA */
+
+static int do_cfgblock_create(struct cmd_tbl *cmdtp, int flag, int argc,
+                             char * const argv[])
+{
+       u8 *config_block;
+       size_t size = TDX_CFG_BLOCK_MAX_SIZE;
+       int offset = 0;
+       int ret = CMD_RET_SUCCESS;
+       int err;
+       int force_overwrite = 0;
 
        if (argc >= 3) {
+#ifdef CONFIG_TDX_CFG_BLOCK_EXTRA
+               if (!strcmp(argv[2], "carrier"))
+                       return do_cfgblock_carrier_create(cmdtp, flag,
+                                                         --argc, ++argv);
+#endif /* CONFIG_TDX_CFG_BLOCK_EXTRA */
                if (argv[2][0] == '-' && argv[2][1] == 'y')
                        force_overwrite = 1;
        }
 
+       /* Allocate RAM area for config block */
+       config_block = memalign(ARCH_DMA_MINALIGN, size);
+       if (!config_block) {
+               printf("Not enough malloc space available!\n");
+               return CMD_RET_FAILURE;
+       }
+
+       memset(config_block, 0xff, size);
+
        read_tdx_cfg_block();
        if (valid_cfgblock) {
 #if defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NAND)
@@ -593,9 +837,11 @@ static int do_cfgblock_create(struct cmd_tbl *cmdtp, int flag, int argc,
                err = get_cfgblock_interactive();
        } else {
                if (force_overwrite)
-                       err = get_cfgblock_barcode(argv[3]);
+                       err = get_cfgblock_barcode(argv[3], &tdx_hw_tag,
+                                                  &tdx_serial);
                else
-                       err = get_cfgblock_barcode(argv[2]);
+                       err = get_cfgblock_barcode(argv[2], &tdx_hw_tag,
+                                                  &tdx_serial);
        }
        if (err) {
                ret = CMD_RET_FAILURE;
@@ -607,39 +853,25 @@ static int do_cfgblock_create(struct cmd_tbl *cmdtp, int flag, int argc,
        tdx_eth_addr.nic = htonl(tdx_serial << 8);
 
        /* Valid Tag */
-       tag = (struct toradex_tag *)config_block;
-       tag->id = TAG_VALID;
-       tag->flags = TAG_FLAG_VALID;
-       tag->len = 0;
-       offset += 4;
+       write_tag(config_block, &offset, TAG_VALID, NULL, 0);
 
        /* Product Tag */
-       tag = (struct toradex_tag *)(config_block + offset);
-       tag->id = TAG_HW;
-       tag->flags = TAG_FLAG_VALID;
-       tag->len = 2;
-       offset += 4;
-
-       memcpy(config_block + offset, &tdx_hw_tag, 8);
-       offset += 8;
+       write_tag(config_block, &offset, TAG_HW, (u8 *)&tdx_hw_tag,
+                 sizeof(tdx_hw_tag));
 
        /* MAC Tag */
-       tag = (struct toradex_tag *)(config_block + offset);
-       tag->id = TAG_MAC;
-       tag->flags = TAG_FLAG_VALID;
-       tag->len = 2;
-       offset += 4;
+       write_tag(config_block, &offset, TAG_MAC, (u8 *)&tdx_eth_addr,
+                 sizeof(tdx_eth_addr));
 
-       memcpy(config_block + offset, &tdx_eth_addr, 6);
-       offset += 6;
        memset(config_block + offset, 0, 32 - offset);
-
 #if defined(CONFIG_TDX_CFG_BLOCK_IS_IN_MMC)
        err = tdx_cfg_block_mmc_storage(config_block, 1);
 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NAND)
        err = write_tdx_cfg_block_to_nand(config_block);
 #elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_NOR)
        err = write_tdx_cfg_block_to_nor(config_block);
+#elif defined(CONFIG_TDX_CFG_BLOCK_IS_IN_EEPROM)
+       err = write_tdx_cfg_block_to_eeprom(config_block);
 #else
        err = -EINVAL;
 #endif
@@ -679,8 +911,10 @@ static int do_cfgblock(struct cmd_tbl *cmdtp, int flag, int argc,
        return CMD_RET_USAGE;
 }
 
-U_BOOT_CMD(cfgblock, 4, 0, do_cfgblock,
-          "Toradex config block handling commands",
-          "create [-y] [barcode] - (Re-)create Toradex config block\n"
-          "cfgblock reload - Reload Toradex config block from flash"
+U_BOOT_CMD(
+       cfgblock, 5, 0, do_cfgblock,
+       "Toradex config block handling commands",
+       "create [-y] [barcode] - (Re-)create Toradex config block\n"
+       "create carrier [-y] [barcode] - (Re-)create Toradex Carrier config block\n"
+       "cfgblock reload - Reload Toradex config block from flash"
 );
index d58be23..e18da33 100644 (file)
@@ -94,9 +94,12 @@ extern const char * const toradex_modules[];
 extern const char * const toradex_carrier_boards[];
 extern bool valid_cfgblock;
 extern struct toradex_hw tdx_hw_tag;
+extern struct toradex_hw tdx_car_hw_tag;
 extern struct toradex_eth_addr tdx_eth_addr;
 extern u32 tdx_serial;
+extern u32 tdx_car_serial;
 
 int read_tdx_cfg_block(void);
+int read_tdx_cfg_block_carrier(void);
 
 #endif /* _TDX_CFG_BLOCK_H */