]> git.ipfire.org Git - people/ms/u-boot.git/blobdiff - common/env_nand.c
Merge tag 'xilinx-for-v2017.09' of git://www.denx.de/git/u-boot-microblaze
[people/ms/u-boot.git] / common / env_nand.c
index e6354728fbc97e826501da1742d9496a8d9d51e9..760f6859e354daeaa5299cf159f53938ae64f975 100644 (file)
  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
  * Andreas Heppel <aheppel@sysgo.de>
  *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
+ * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
@@ -35,6 +19,7 @@
 #include <environment.h>
 #include <linux/stddef.h>
 #include <malloc.h>
+#include <memalign.h>
 #include <nand.h>
 #include <search.h>
 #include <errno.h>
@@ -140,22 +125,27 @@ int env_init(void)
  * The legacy NAND code saved the environment in the first NAND device i.e.,
  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
  */
-int writeenv(size_t offset, u_char *buf)
+static int writeenv(size_t offset, u_char *buf)
 {
        size_t end = offset + CONFIG_ENV_RANGE;
        size_t amount_saved = 0;
        size_t blocksize, len;
+       struct mtd_info *mtd;
        u_char *char_ptr;
 
-       blocksize = nand_info[0].erasesize;
-       len = min(blocksize, CONFIG_ENV_SIZE);
+       mtd = get_nand_dev_by_index(0);
+       if (!mtd)
+               return 1;
+
+       blocksize = mtd->erasesize;
+       len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
 
        while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
-               if (nand_block_isbad(&nand_info[0], offset)) {
+               if (nand_block_isbad(mtd, offset)) {
                        offset += blocksize;
                } else {
                        char_ptr = &buf[amount_saved];
-                       if (nand_write(&nand_info[0], offset, &len, char_ptr))
+                       if (nand_write(mtd, offset, &len, char_ptr))
                                return 1;
 
                        offset += blocksize;
@@ -168,120 +158,116 @@ int writeenv(size_t offset, u_char *buf)
        return 0;
 }
 
-#ifdef CONFIG_ENV_OFFSET_REDUND
-static unsigned char env_flags;
+struct env_location {
+       const char *name;
+       const nand_erase_options_t erase_opts;
+};
 
-int saveenv(void)
+static int erase_and_write_env(const struct env_location *location,
+               u_char *env_new)
 {
-       env_t   env_new;
-       ssize_t len;
-       char    *res;
-       int     ret = 0;
-       nand_erase_options_t nand_erase_options;
+       struct mtd_info *mtd;
+       int ret = 0;
 
-       memset(&nand_erase_options, 0, sizeof(nand_erase_options));
-       nand_erase_options.length = CONFIG_ENV_RANGE;
-
-       if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
+       mtd = get_nand_dev_by_index(0);
+       if (!mtd)
                return 1;
 
-       res = (char *)&env_new.data;
-       len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
-       if (len < 0) {
-               error("Cannot export environment: errno = %d\n", errno);
+       printf("Erasing %s...\n", location->name);
+       if (nand_erase_opts(mtd, &location->erase_opts))
                return 1;
-       }
-       env_new.crc     = crc32(0, env_new.data, ENV_SIZE);
-       env_new.flags   = ++env_flags; /* increase the serial */
-
-       if (gd->env_valid == 1) {
-               puts("Erasing redundant NAND...\n");
-               nand_erase_options.offset = CONFIG_ENV_OFFSET_REDUND;
-               if (nand_erase_opts(&nand_info[0], &nand_erase_options))
-                       return 1;
 
-               puts("Writing to redundant NAND... ");
-               ret = writeenv(CONFIG_ENV_OFFSET_REDUND, (u_char *)&env_new);
-       } else {
-               puts("Erasing NAND...\n");
-               nand_erase_options.offset = CONFIG_ENV_OFFSET;
-               if (nand_erase_opts(&nand_info[0], &nand_erase_options))
-                       return 1;
-
-               puts("Writing to NAND... ");
-               ret = writeenv(CONFIG_ENV_OFFSET, (u_char *)&env_new);
-       }
-       if (ret) {
-               puts("FAILED!\n");
-               return 1;
-       }
-
-       puts("done\n");
-
-       gd->env_valid = gd->env_valid == 2 ? 1 : 2;
+       printf("Writing to %s... ", location->name);
+       ret = writeenv(location->erase_opts.offset, env_new);
+       puts(ret ? "FAILED!\n" : "OK\n");
 
        return ret;
 }
-#else /* ! CONFIG_ENV_OFFSET_REDUND */
+
 int saveenv(void)
 {
        int     ret = 0;
-       ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, sizeof(env_t));
-       ssize_t len;
-       char    *res;
-       nand_erase_options_t nand_erase_options;
+       ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
+       int     env_idx = 0;
+       static const struct env_location location[] = {
+               {
+                       .name = "NAND",
+                       .erase_opts = {
+                               .length = CONFIG_ENV_RANGE,
+                               .offset = CONFIG_ENV_OFFSET,
+                       },
+               },
+#ifdef CONFIG_ENV_OFFSET_REDUND
+               {
+                       .name = "redundant NAND",
+                       .erase_opts = {
+                               .length = CONFIG_ENV_RANGE,
+                               .offset = CONFIG_ENV_OFFSET_REDUND,
+                       },
+               },
+#endif
+       };
 
-       memset(&nand_erase_options, 0, sizeof(nand_erase_options));
-       nand_erase_options.length = CONFIG_ENV_RANGE;
-       nand_erase_options.offset = CONFIG_ENV_OFFSET;
 
        if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
                return 1;
 
-       res = (char *)&env_new->data;
-       len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
-       if (len < 0) {
-               error("Cannot export environment: errno = %d\n", errno);
-               return 1;
-       }
-       env_new->crc = crc32(0, env_new->data, ENV_SIZE);
+       ret = env_export(env_new);
+       if (ret)
+               return ret;
 
-       puts("Erasing Nand...\n");
-       if (nand_erase_opts(&nand_info[0], &nand_erase_options))
-               return 1;
+#ifdef CONFIG_ENV_OFFSET_REDUND
+       env_idx = (gd->env_valid == 1);
+#endif
 
-       puts("Writing to Nand... ");
-       if (writeenv(CONFIG_ENV_OFFSET, (u_char *)env_new)) {
-               puts("FAILED!\n");
-               return 1;
+       ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
+#ifdef CONFIG_ENV_OFFSET_REDUND
+       if (!ret) {
+               /* preset other copy for next write */
+               gd->env_valid = gd->env_valid == 2 ? 1 : 2;
+               return ret;
        }
 
-       puts("done\n");
+       env_idx = (env_idx + 1) & 1;
+       ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
+       if (!ret)
+               printf("Warning: primary env write failed,"
+                               " redundancy is lost!\n");
+#endif
+
        return ret;
 }
-#endif /* CONFIG_ENV_OFFSET_REDUND */
 #endif /* CMD_SAVEENV */
 
-int readenv(size_t offset, u_char *buf)
+#if defined(CONFIG_SPL_BUILD)
+static int readenv(size_t offset, u_char *buf)
+{
+       return nand_spl_load_image(offset, CONFIG_ENV_SIZE, buf);
+}
+#else
+static int readenv(size_t offset, u_char *buf)
 {
        size_t end = offset + CONFIG_ENV_RANGE;
        size_t amount_loaded = 0;
        size_t blocksize, len;
+       struct mtd_info *mtd;
        u_char *char_ptr;
 
-       blocksize = nand_info[0].erasesize;
-       if (!blocksize)
+       mtd = get_nand_dev_by_index(0);
+       if (!mtd)
                return 1;
 
-       len = min(blocksize, CONFIG_ENV_SIZE);
+       blocksize = mtd->erasesize;
+       len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
 
        while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
-               if (nand_block_isbad(&nand_info[0], offset)) {
+               if (nand_block_isbad(mtd, offset)) {
                        offset += blocksize;
                } else {
                        char_ptr = &buf[amount_loaded];
-                       if (nand_read_skip_bad(&nand_info[0], offset,
-                                              &len, char_ptr))
+                       if (nand_read_skip_bad(mtd, offset,
+                                              &len, NULL,
+                                              mtd->size, char_ptr))
                                return 1;
 
                        offset += blocksize;
@@ -294,9 +280,10 @@ int readenv(size_t offset, u_char *buf)
 
        return 0;
 }
+#endif /* #if defined(CONFIG_SPL_BUILD) */
 
 #ifdef CONFIG_ENV_OFFSET_OOB
-int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
+int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result)
 {
        struct mtd_oob_ops ops;
        uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
@@ -308,14 +295,14 @@ int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
        ops.ooblen      = ENV_OFFSET_SIZE;
        ops.oobbuf      = (void *)oob_buf;
 
-       ret = nand->read_oob(nand, ENV_OFFSET_SIZE, &ops);
+       ret = mtd->read_oob(mtd, ENV_OFFSET_SIZE, &ops);
        if (ret) {
                printf("error reading OOB block 0\n");
                return ret;
        }
 
        if (oob_buf[0] == ENV_OOB_MARKER) {
-               *result = oob_buf[1] * nand->erasesize;
+               *result = oob_buf[1] * mtd->erasesize;
        } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
                *result = oob_buf[1];
        } else {
@@ -331,8 +318,8 @@ int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
 void env_relocate_spec(void)
 {
 #if !defined(ENV_IS_EMBEDDED)
-       int crc1_ok = 0, crc2_ok = 0;
-       env_t *ep, *tmp_env1, *tmp_env2;
+       int read1_fail = 0, read2_fail = 0;
+       env_t *tmp_env1, *tmp_env2;
 
        tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
        tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
@@ -342,46 +329,28 @@ void env_relocate_spec(void)
                goto done;
        }
 
-       if (readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1))
-               puts("No Valid Environment Area found\n");
-
-       if (readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2))
-               puts("No Valid Redundant Environment Area found\n");
+       read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
+       read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
 
-       crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
-       crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
+       if (read1_fail && read2_fail)
+               puts("*** Error - No Valid Environment Area found\n");
+       else if (read1_fail || read2_fail)
+               puts("*** Warning - some problems detected "
+                    "reading environment; recovered successfully\n");
 
-       if (!crc1_ok && !crc2_ok) {
-               set_default_env("!bad CRC");
+       if (read1_fail && read2_fail) {
+               set_default_env("!bad env area");
                goto done;
-       } else if (crc1_ok && !crc2_ok) {
+       } else if (!read1_fail && read2_fail) {
                gd->env_valid = 1;
-       } else if (!crc1_ok && crc2_ok) {
+               env_import((char *)tmp_env1, 1);
+       } else if (read1_fail && !read2_fail) {
                gd->env_valid = 2;
+               env_import((char *)tmp_env2, 1);
        } else {
-               /* both ok - check serial */
-               if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
-                       gd->env_valid = 2;
-               else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
-                       gd->env_valid = 1;
-               else if (tmp_env1->flags > tmp_env2->flags)
-                       gd->env_valid = 1;
-               else if (tmp_env2->flags > tmp_env1->flags)
-                       gd->env_valid = 2;
-               else /* flags are equal - almost impossible */
-                       gd->env_valid = 1;
+               env_import_redund((char *)tmp_env1, (char *)tmp_env2);
        }
 
-       free(env_ptr);
-
-       if (gd->env_valid == 1)
-               ep = tmp_env1;
-       else
-               ep = tmp_env2;
-
-       env_flags = ep->flags;
-       env_import((char *)ep, 0);
-
 done:
        free(tmp_env1);
        free(tmp_env2);
@@ -401,12 +370,12 @@ void env_relocate_spec(void)
        ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 
 #if defined(CONFIG_ENV_OFFSET_OOB)
-       ret = get_nand_env_oob(&nand_info[0], &nand_env_oob_offset);
+       struct mtd_info *mtd  = get_nand_dev_by_index(0);
        /*
         * If unable to read environment offset from NAND OOB then fall through
         * to the normal environment reading code below
         */
-       if (!ret) {
+       if (mtd && !get_nand_env_oob(mtd, &nand_env_oob_offset)) {
                printf("Found Environment offset in OOB..\n");
        } else {
                set_default_env("!no env offset in OOB");