env: Fix saving environment to "bad CRC" location
[oweals/u-boot.git] / env / sf.c
index 6f74371c098203e2ba9c805227da7a9a492bae7a..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
@@ -58,9 +58,10 @@ 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");
+               set_default_env("spi_flash_probe_bus_cs() failed", 0);
                return ret;
        }
 
@@ -72,7 +73,7 @@ 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");
+                       set_default_env("spi_flash_probe() failed", 0);
                        return -EIO;
                }
        }
@@ -80,6 +81,40 @@ static int setup_flash_device(void)
        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
 static int env_sf_save(void)
@@ -115,8 +150,8 @@ static int env_sf_save(void)
                        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;
        }
@@ -165,17 +200,15 @@ static int env_sf_save(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;
        }
@@ -184,63 +217,14 @@ static int env_sf_load(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;
-       }
+       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);
 
-       if (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc)
-               crc1_ok = 1;
+       ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
+                               read2_fail);
 
-       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");
-               ret = -EIO;
-               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;
-
-       ret = env_import((char *)ep, 0);
-       if (!ret) {
-               error("Cannot import environment: errno = %d\n", errno);
-               set_default_env("!env_import failed");
-       }
-
-err_read:
        spi_flash_free(env_flash);
        env_flash = NULL;
 out:
@@ -270,8 +254,8 @@ static int env_sf_save(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;
        }
@@ -319,7 +303,7 @@ static int env_sf_load(void)
 
        buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
        if (!buf) {
-               set_default_env("!malloc() failed");
+               set_default_env("malloc() failed", 0);
                return -EIO;
        }
 
@@ -327,15 +311,15 @@ static int env_sf_load(void)
        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:
@@ -348,6 +332,30 @@ out:
 }
 #endif
 
+#ifdef CONFIG_ENV_ADDR
+__weak void *env_sf_get_env_addr(void)
+{
+       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,
        ENV_NAME("SPI Flash")
@@ -355,4 +363,7 @@ U_BOOT_ENV_LOCATION(sf) = {
 #ifdef CMD_SAVEENV
        .save           = env_save_ptr(env_sf_save),
 #endif
+#if defined(INITENV) && defined(CONFIG_ENV_ADDR)
+       .init           = env_sf_init,
+#endif
 };