env: Fix saving environment to "bad CRC" location
[oweals/u-boot.git] / env / sf.c
index 8f81cf5e40298b6b46be63c60b459d3803fd1a8c..b3dec82c353afea75ef183145c689b34560445e2 100644 (file)
--- a/env/sf.c
+++ b/env/sf.c
@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2000-2010
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
@@ -6,8 +7,6 @@
  * Andreas Heppel <aheppel@sysgo.de>
  *
  * (C) Copyright 2008 Atmel Corporation
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 #include <common.h>
 #include <dm.h>
@@ -34,6 +33,7 @@
 
 #ifndef CONFIG_SPL_BUILD
 #define CMD_SAVEENV
+#define INITENV
 #endif
 
 #ifdef CONFIG_ENV_OFFSET_REDUND
@@ -48,8 +48,6 @@ static ulong env_new_offset   = CONFIG_ENV_OFFSET_REDUND;
 
 DECLARE_GLOBAL_DATA_PTR;
 
-char *env_name_spec = "SPI Flash";
-
 static struct spi_flash *env_flash;
 
 static int setup_flash_device(void)
@@ -60,10 +58,11 @@ static int setup_flash_device(void)
 
        /* speed and mode will be read from DT */
        ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
-                                    0, 0, &new);
+                                    CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
+                                    &new);
        if (ret) {
-               set_default_env("!spi_flash_probe_bus_cs() failed");
-               return 1;
+               set_default_env("spi_flash_probe_bus_cs() failed", 0);
+               return ret;
        }
 
        env_flash = dev_get_uclass_priv(new);
@@ -74,17 +73,51 @@ static int setup_flash_device(void)
                        CONFIG_ENV_SPI_CS,
                        CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
                if (!env_flash) {
-                       set_default_env("!spi_flash_probe() failed");
-                       return 1;
+                       set_default_env("spi_flash_probe() failed", 0);
+                       return -EIO;
                }
        }
 #endif
        return 0;
 }
 
+static int is_end(const char *addr, size_t size)
+{
+       /* The end of env variables is marked by '\0\0' */
+       int i = 0;
+
+       for (i = 0; i < size - 1; ++i)
+               if (addr[i] == 0x0 && addr[i + 1] == 0x0)
+                       return 1;
+       return 0;
+}
+
+static int spi_flash_read_env(struct spi_flash *flash, u32 offset, size_t len,
+                             void *buf)
+{
+       u32 addr = 0;
+       u32 page_size = flash->page_size;
+
+       memset(buf, 0x0, len);
+       for (int i = 0; i < len / page_size; ++i) {
+               int ret = spi_flash_read(flash, offset, page_size,
+                                        &((char *)buf)[addr]);
+
+               if (ret < 0)
+                       return ret;
+
+               if (is_end(&((char *)buf)[addr], page_size))
+                       return 0;
+
+               addr += page_size;
+               offset += page_size;
+       }
+       return 0;
+}
+
 #if defined(CONFIG_ENV_OFFSET_REDUND)
 #ifdef CMD_SAVEENV
-int saveenv(void)
+static int env_sf_save(void)
 {
        env_t   env_new;
        char    *saved_buffer = NULL, flag = OBSOLETE_FLAG;
@@ -97,7 +130,7 @@ int saveenv(void)
 
        ret = env_export(&env_new);
        if (ret)
-               return ret;
+               return -EIO;
        env_new.flags   = ACTIVE_FLAG;
 
        if (gd->env_valid == ENV_VALID) {
@@ -114,11 +147,11 @@ int saveenv(void)
                saved_offset = env_new_offset + CONFIG_ENV_SIZE;
                saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
                if (!saved_buffer) {
-                       ret = 1;
+                       ret = -ENOMEM;
                        goto done;
                }
-               ret = spi_flash_read(env_flash, saved_offset,
-                                       saved_size, saved_buffer);
+               ret = spi_flash_read_env(env_flash, saved_offset,
+                                        saved_size, saved_buffer);
                if (ret)
                        goto done;
        }
@@ -164,20 +197,19 @@ int saveenv(void)
 }
 #endif /* CMD_SAVEENV */
 
-void env_relocate_spec(void)
+static int env_sf_load(void)
 {
        int ret;
-       int crc1_ok = 0, crc2_ok = 0;
-       env_t *tmp_env1 = NULL;
-       env_t *tmp_env2 = NULL;
-       env_t *ep = NULL;
+       int read1_fail, read2_fail;
+       env_t *tmp_env1, *tmp_env2;
 
        tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
                        CONFIG_ENV_SIZE);
        tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
                        CONFIG_ENV_SIZE);
        if (!tmp_env1 || !tmp_env2) {
-               set_default_env("!malloc() failed");
+               set_default_env("malloc() failed", 0);
+               ret = -EIO;
                goto out;
        }
 
@@ -185,71 +217,25 @@ void env_relocate_spec(void)
        if (ret)
                goto out;
 
-       ret = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
-                               CONFIG_ENV_SIZE, tmp_env1);
-       if (ret) {
-               set_default_env("!spi_flash_read() failed");
-               goto err_read;
-       }
-
-       if (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc)
-               crc1_ok = 1;
-
-       ret = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
-                               CONFIG_ENV_SIZE, tmp_env2);
-       if (!ret) {
-               if (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc)
-                       crc2_ok = 1;
-       }
-
-       if (!crc1_ok && !crc2_ok) {
-               set_default_env("!bad CRC");
-               goto err_read;
-       } else if (crc1_ok && !crc2_ok) {
-               gd->env_valid = ENV_VALID;
-       } else if (!crc1_ok && crc2_ok) {
-               gd->env_valid = ENV_REDUND;
-       } else if (tmp_env1->flags == ACTIVE_FLAG &&
-                  tmp_env2->flags == OBSOLETE_FLAG) {
-               gd->env_valid = ENV_VALID;
-       } else if (tmp_env1->flags == OBSOLETE_FLAG &&
-                  tmp_env2->flags == ACTIVE_FLAG) {
-               gd->env_valid = ENV_REDUND;
-       } else if (tmp_env1->flags == tmp_env2->flags) {
-               gd->env_valid = ENV_VALID;
-       } else if (tmp_env1->flags == 0xFF) {
-               gd->env_valid = ENV_VALID;
-       } else if (tmp_env2->flags == 0xFF) {
-               gd->env_valid = ENV_REDUND;
-       } else {
-               /*
-                * this differs from code in env_flash.c, but I think a sane
-                * default path is desirable.
-                */
-               gd->env_valid = ENV_VALID;
-       }
-
-       if (gd->env_valid == ENV_VALID)
-               ep = tmp_env1;
-       else
-               ep = tmp_env2;
+       read1_fail = spi_flash_read_env(env_flash, CONFIG_ENV_OFFSET,
+                                       CONFIG_ENV_SIZE, tmp_env1);
+       read2_fail = spi_flash_read_env(env_flash, CONFIG_ENV_OFFSET_REDUND,
+                                       CONFIG_ENV_SIZE, tmp_env2);
 
-       ret = env_import((char *)ep, 0);
-       if (!ret) {
-               error("Cannot import environment: errno = %d\n", errno);
-               set_default_env("!env_import failed");
-       }
+       ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
+                               read2_fail);
 
-err_read:
        spi_flash_free(env_flash);
        env_flash = NULL;
 out:
        free(tmp_env1);
        free(tmp_env2);
+
+       return ret;
 }
 #else
 #ifdef CMD_SAVEENV
-int saveenv(void)
+static int env_sf_save(void)
 {
        u32     saved_size, saved_offset, sector;
        char    *saved_buffer = NULL;
@@ -268,8 +254,8 @@ int saveenv(void)
                if (!saved_buffer)
                        goto done;
 
-               ret = spi_flash_read(env_flash, saved_offset,
-                       saved_size, saved_buffer);
+               ret = spi_flash_read_env(env_flash, saved_offset,
+                                        saved_size, saved_buffer);
                if (ret)
                        goto done;
        }
@@ -310,30 +296,30 @@ int saveenv(void)
 }
 #endif /* CMD_SAVEENV */
 
-void env_relocate_spec(void)
+static int env_sf_load(void)
 {
        int ret;
        char *buf = NULL;
 
        buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
        if (!buf) {
-               set_default_env("!malloc() failed");
-               return;
+               set_default_env("malloc() failed", 0);
+               return -EIO;
        }
 
        ret = setup_flash_device();
        if (ret)
                goto out;
 
-       ret = spi_flash_read(env_flash,
-               CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
+       ret = spi_flash_read_env(env_flash, CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE,
+                                buf);
        if (ret) {
-               set_default_env("!spi_flash_read() failed");
+               set_default_env("spi_flash_read_env() failed", 0);
                goto err_read;
        }
 
        ret = env_import(buf, 1);
-       if (ret)
+       if (!ret)
                gd->env_valid = ENV_VALID;
 
 err_read:
@@ -341,24 +327,43 @@ err_read:
        env_flash = NULL;
 out:
        free(buf);
+
+       return ret;
 }
 #endif
 
-int env_init(void)
+#ifdef CONFIG_ENV_ADDR
+__weak void *env_sf_get_env_addr(void)
 {
-       /* SPI flash isn't usable before relocation */
-       gd->env_addr = (ulong)&default_environment[0];
-       gd->env_valid = ENV_VALID;
+       return (void *)CONFIG_ENV_ADDR;
+}
+#endif
+
+#if defined(INITENV) && defined(CONFIG_ENV_ADDR)
+static int env_sf_init(void)
+{
+       env_t *env_ptr = (env_t *)env_sf_get_env_addr();
+
+       if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
+               gd->env_addr    = (ulong)&(env_ptr->data);
+               gd->env_valid   = 1;
+       } else {
+               gd->env_addr = (ulong)&default_environment[0];
+               gd->env_valid = 1;
+       }
 
        return 0;
 }
+#endif
 
 U_BOOT_ENV_LOCATION(sf) = {
        .location       = ENVL_SPI_FLASH,
-       .get_char       = env_get_char_spec,
-       .load           = env_relocate_spec,
+       ENV_NAME("SPI Flash")
+       .load           = env_sf_load,
 #ifdef CMD_SAVEENV
-       .save           = env_save_ptr(saveenv),
+       .save           = env_save_ptr(env_sf_save),
+#endif
+#if defined(INITENV) && defined(CONFIG_ENV_ADDR)
+       .init           = env_sf_init,
 #endif
-       .init           = env_init,
 };