Merge branch '2022-08-04-Kconfig-migrations'
[platform/kernel/u-boot.git] / env / sf.c
index 22b70ad..a425ecc 100644 (file)
--- a/env/sf.c
+++ b/env/sf.c
 #include <spi_flash.h>
 #include <search.h>
 #include <errno.h>
+#include <uuid.h>
+#include <asm/cache.h>
+#include <asm/global_data.h>
 #include <dm/device-internal.h>
 #include <u-boot/crc.h>
 
-#ifndef CONFIG_SPL_BUILD
-#define INITENV
-#endif
+#define        OFFSET_INVALID          (~(u32)0)
 
 #ifdef CONFIG_ENV_OFFSET_REDUND
+#define ENV_OFFSET_REDUND      CONFIG_ENV_OFFSET_REDUND
+
 static ulong env_offset                = CONFIG_ENV_OFFSET;
 static ulong env_new_offset    = CONFIG_ENV_OFFSET_REDUND;
+
+#else
+
+#define ENV_OFFSET_REDUND      OFFSET_INVALID
+
 #endif /* CONFIG_ENV_OFFSET_REDUND */
 
 DECLARE_GLOBAL_DATA_PTR;
 
-static struct spi_flash *env_flash;
-
-static int setup_flash_device(void)
+static int setup_flash_device(struct spi_flash **env_flash)
 {
-#ifdef CONFIG_DM_SPI_FLASH
+#if CONFIG_IS_ENABLED(DM_SPI_FLASH)
        struct udevice *new;
        int     ret;
 
        /* speed and mode will be read from DT */
        ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
-                                    CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
                                     &new);
        if (ret) {
                env_set_default("spi_flash_probe_bus_cs() failed", 0);
                return ret;
        }
 
-       env_flash = dev_get_uclass_priv(new);
+       *env_flash = dev_get_uclass_priv(new);
 #else
-
-       if (!env_flash) {
-               env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
-                       CONFIG_ENV_SPI_CS,
-                       CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
-               if (!env_flash) {
-                       env_set_default("spi_flash_probe() failed", 0);
-                       return -EIO;
-               }
+       *env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
+                                    CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
+       if (!*env_flash) {
+               env_set_default("spi_flash_probe() failed", 0);
+               return -EIO;
        }
 #endif
        return 0;
@@ -69,13 +70,18 @@ static int env_sf_save(void)
 {
        env_t   env_new;
        char    *saved_buffer = NULL, flag = ENV_REDUND_OBSOLETE;
-       u32     saved_size, saved_offset, sector;
+       u32     saved_size = 0, saved_offset = 0, sector;
+       u32     sect_size = CONFIG_ENV_SECT_SIZE;
        int     ret;
+       struct spi_flash *env_flash;
 
-       ret = setup_flash_device();
+       ret = setup_flash_device(&env_flash);
        if (ret)
                return ret;
 
+       if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
+               sect_size = env_flash->mtd.erasesize;
+
        ret = env_export(&env_new);
        if (ret)
                return -EIO;
@@ -90,8 +96,8 @@ static int env_sf_save(void)
        }
 
        /* Is the sector larger than the env (i.e. embedded) */
-       if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
-               saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
+       if (sect_size > CONFIG_ENV_SIZE) {
+               saved_size = sect_size - CONFIG_ENV_SIZE;
                saved_offset = env_new_offset + CONFIG_ENV_SIZE;
                saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
                if (!saved_buffer) {
@@ -104,11 +110,11 @@ static int env_sf_save(void)
                        goto done;
        }
 
-       sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
+       sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
 
        puts("Erasing SPI flash...");
        ret = spi_flash_erase(env_flash, env_new_offset,
-                               sector * CONFIG_ENV_SECT_SIZE);
+                               sector * sect_size);
        if (ret)
                goto done;
 
@@ -119,7 +125,7 @@ static int env_sf_save(void)
        if (ret)
                goto done;
 
-       if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
+       if (sect_size > CONFIG_ENV_SIZE) {
                ret = spi_flash_write(env_flash, saved_offset,
                                        saved_size, saved_buffer);
                if (ret)
@@ -137,7 +143,9 @@ static int env_sf_save(void)
 
        printf("Valid environment: %d\n", (int)gd->env_valid);
 
- done:
+done:
+       spi_flash_free(env_flash);
+
        if (saved_buffer)
                free(saved_buffer);
 
@@ -149,6 +157,7 @@ static int env_sf_load(void)
        int ret;
        int read1_fail, read2_fail;
        env_t *tmp_env1, *tmp_env2;
+       struct spi_flash *env_flash;
 
        tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
                        CONFIG_ENV_SIZE);
@@ -160,7 +169,7 @@ static int env_sf_load(void)
                goto out;
        }
 
-       ret = setup_flash_device();
+       ret = setup_flash_device(&env_flash);
        if (ret)
                goto out;
 
@@ -170,10 +179,9 @@ static int env_sf_load(void)
                                    CONFIG_ENV_SIZE, tmp_env2);
 
        ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
-                               read2_fail);
+                               read2_fail, H_EXTERNAL);
 
        spi_flash_free(env_flash);
-       env_flash = NULL;
 out:
        free(tmp_env1);
        free(tmp_env2);
@@ -183,18 +191,23 @@ out:
 #else
 static int env_sf_save(void)
 {
-       u32     saved_size, saved_offset, sector;
+       u32     saved_size = 0, saved_offset = 0, sector;
+       u32     sect_size = CONFIG_ENV_SECT_SIZE;
        char    *saved_buffer = NULL;
        int     ret = 1;
        env_t   env_new;
+       struct spi_flash *env_flash;
 
-       ret = setup_flash_device();
+       ret = setup_flash_device(&env_flash);
        if (ret)
                return ret;
 
+       if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
+               sect_size = env_flash->mtd.erasesize;
+
        /* Is the sector larger than the env (i.e. embedded) */
-       if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
-               saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
+       if (sect_size > CONFIG_ENV_SIZE) {
+               saved_size = sect_size - CONFIG_ENV_SIZE;
                saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
                saved_buffer = malloc(saved_size);
                if (!saved_buffer)
@@ -210,11 +223,11 @@ static int env_sf_save(void)
        if (ret)
                goto done;
 
-       sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
+       sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
 
        puts("Erasing SPI flash...");
        ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
-               sector * CONFIG_ENV_SECT_SIZE);
+               sector * sect_size);
        if (ret)
                goto done;
 
@@ -224,7 +237,7 @@ static int env_sf_save(void)
        if (ret)
                goto done;
 
-       if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
+       if (sect_size > CONFIG_ENV_SIZE) {
                ret = spi_flash_write(env_flash, saved_offset,
                        saved_size, saved_buffer);
                if (ret)
@@ -234,7 +247,9 @@ static int env_sf_save(void)
        ret = 0;
        puts("done\n");
 
- done:
+done:
+       spi_flash_free(env_flash);
+
        if (saved_buffer)
                free(saved_buffer);
 
@@ -245,6 +260,7 @@ static int env_sf_load(void)
 {
        int ret;
        char *buf = NULL;
+       struct spi_flash *env_flash;
 
        buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
        if (!buf) {
@@ -252,7 +268,7 @@ static int env_sf_load(void)
                return -EIO;
        }
 
-       ret = setup_flash_device();
+       ret = setup_flash_device(&env_flash);
        if (ret)
                goto out;
 
@@ -263,13 +279,12 @@ static int env_sf_load(void)
                goto err_read;
        }
 
-       ret = env_import(buf, 1);
+       ret = env_import(buf, 1, H_EXTERNAL);
        if (!ret)
                gd->env_valid = ENV_VALID;
 
 err_read:
        spi_flash_free(env_flash);
-       env_flash = NULL;
 out:
        free(buf);
 
@@ -277,36 +292,163 @@ out:
 }
 #endif
 
-#if CONFIG_ENV_ADDR != 0x0
+static int env_sf_erase(void)
+{
+       int ret;
+       env_t env;
+       struct spi_flash *env_flash;
+
+       ret = setup_flash_device(&env_flash);
+       if (ret)
+               return ret;
+
+       memset(&env, 0, sizeof(env_t));
+       ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, &env);
+       if (ret)
+               goto done;
+
+       if (ENV_OFFSET_REDUND != OFFSET_INVALID)
+               ret = spi_flash_write(env_flash, ENV_OFFSET_REDUND, CONFIG_ENV_SIZE, &env);
+
+done:
+       spi_flash_free(env_flash);
+
+       return ret;
+}
+
 __weak void *env_sf_get_env_addr(void)
 {
+#ifndef CONFIG_SPL_BUILD
        return (void *)CONFIG_ENV_ADDR;
-}
+#else
+       return NULL;
 #endif
+}
 
-#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
-static int env_sf_init(void)
+/*
+ * check if Environment on CONFIG_ENV_ADDR is valid.
+ */
+static int env_sf_init_addr(void)
 {
        env_t *env_ptr = (env_t *)env_sf_get_env_addr();
 
+       if (!env_ptr)
+               return -ENOENT;
+
        if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
-               gd->env_addr    = (ulong)&(env_ptr->data);
-               gd->env_valid   = 1;
+               gd->env_addr = (ulong)&(env_ptr->data);
+               gd->env_valid = ENV_VALID;
        } else {
-               gd->env_addr = (ulong)&default_environment[0];
-               gd->env_valid = 1;
+               gd->env_valid = ENV_INVALID;
        }
 
        return 0;
 }
+
+#if defined(CONFIG_ENV_SPI_EARLY)
+/*
+ * early load environment from SPI flash (before relocation)
+ * and check if it is valid.
+ */
+static int env_sf_init_early(void)
+{
+       int ret;
+       int read1_fail;
+       int read2_fail;
+       int crc1_ok;
+       env_t *tmp_env2 = NULL;
+       env_t *tmp_env1;
+       struct spi_flash *env_flash;
+
+       /*
+        * if malloc is not ready yet, we cannot use
+        * this part yet.
+        */
+       if (!gd->malloc_limit)
+               return -ENOENT;
+
+       tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
+                       CONFIG_ENV_SIZE);
+       if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
+               tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
+                                            CONFIG_ENV_SIZE);
+
+       if (!tmp_env1 || !tmp_env2)
+               goto out;
+
+       ret = setup_flash_device(&env_flash);
+       if (ret)
+               goto out;
+
+       read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
+                                   CONFIG_ENV_SIZE, tmp_env1);
+
+       if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
+               read2_fail = spi_flash_read(env_flash,
+                                           CONFIG_ENV_OFFSET_REDUND,
+                                           CONFIG_ENV_SIZE, tmp_env2);
+               ret = env_check_redund((char *)tmp_env1, read1_fail,
+                                      (char *)tmp_env2, read2_fail);
+
+               if (ret < 0)
+                       goto err_read;
+
+               if (gd->env_valid == ENV_VALID)
+                       gd->env_addr = (unsigned long)&tmp_env1->data;
+               else
+                       gd->env_addr = (unsigned long)&tmp_env2->data;
+       } else {
+               if (read1_fail)
+                       goto err_read;
+
+               crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
+                               tmp_env1->crc;
+               if (!crc1_ok)
+                       goto err_read;
+
+               /* if valid -> this is our env */
+               gd->env_valid = ENV_VALID;
+               gd->env_addr = (unsigned long)&tmp_env1->data;
+       }
+
+       spi_flash_free(env_flash);
+
+       return 0;
+err_read:
+       spi_flash_free(env_flash);
+
+       free(tmp_env1);
+       if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
+               free(tmp_env2);
+out:
+       /* env is not valid. always return 0 */
+       gd->env_valid = ENV_INVALID;
+       return 0;
+}
+#endif
+
+static int env_sf_init(void)
+{
+       int ret = env_sf_init_addr();
+       if (ret != -ENOENT)
+               return ret;
+#ifdef CONFIG_ENV_SPI_EARLY
+       return env_sf_init_early();
 #endif
+       /*
+        * return here -ENOENT, so env_init()
+        * can set the init bit and later if no
+        * other Environment storage is defined
+        * can set the default environment
+        */
+       return -ENOENT;
+}
 
 U_BOOT_ENV_LOCATION(sf) = {
        .location       = ENVL_SPI_FLASH,
-       ENV_NAME("SPI Flash")
+       ENV_NAME("SPIFlash")
        .load           = env_sf_load,
        .save           = ENV_SAVE_PTR(env_sf_save),
-#if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
+       .erase          = ENV_ERASE_PTR(env_sf_erase),
        .init           = env_sf_init,
-#endif
 };