env/nand.c

   1 /*
   2  * (C) Copyright 2000-2010
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * (C) Copyright 2008
   6  * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
   7  *
   8  * (C) Copyright 2004
   9  * Jian Zhang, Texas Instruments, jzhang@ti.com.
  10  *
  11  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
  12  * Andreas Heppel <aheppel@sysgo.de>
  13  *
  14  * SPDX-License-Identifier:     GPL-2.0+
  15  */
  16
  17 #include <common.h>
  18 #include <command.h>
  19 #include <environment.h>
  20 #include <linux/stddef.h>
  21 #include <malloc.h>
  22 #include <memalign.h>
  23 #include <nand.h>
  24 #include <search.h>
  25 #include <errno.h>
  26
  27 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND) && \
  28                 !defined(CONFIG_SPL_BUILD)
  29 #define CMD_SAVEENV
  30 #elif defined(CONFIG_ENV_OFFSET_REDUND)
  31 #error CONFIG_ENV_OFFSET_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
  32 #endif
  33
  34 #if defined(CONFIG_ENV_SIZE_REDUND) &&  \
  35         (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
  36 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
  37 #endif
  38
  39 #ifndef CONFIG_ENV_RANGE
  40 #define CONFIG_ENV_RANGE        CONFIG_ENV_SIZE
  41 #endif
  42
  43 char *env_name_spec = "NAND";
  44
  45 #if defined(ENV_IS_EMBEDDED)
  46 env_t *env_ptr = &environment;
  47 #elif defined(CONFIG_NAND_ENV_DST)
  48 env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
  49 #else /* ! ENV_IS_EMBEDDED */
  50 env_t *env_ptr;
  51 #endif /* ENV_IS_EMBEDDED */
  52
  53 DECLARE_GLOBAL_DATA_PTR;
  54
  55 /*
  56  * This is called before nand_init() so we can't read NAND to
  57  * validate env data.
  58  *
  59  * Mark it OK for now. env_relocate() in env_common.c will call our
  60  * relocate function which does the real validation.
  61  *
  62  * When using a NAND boot image (like sequoia_nand), the environment
  63  * can be embedded or attached to the U-Boot image in NAND flash.
  64  * This way the SPL loads not only the U-Boot image from NAND but
  65  * also the environment.
  66  */
  67 static int env_nand_init(void)
  68 {
  69 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
  70         int crc1_ok = 0, crc2_ok = 0;
  71         env_t *tmp_env1;
  72
  73 #ifdef CONFIG_ENV_OFFSET_REDUND
  74         env_t *tmp_env2;
  75
  76         tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
  77         crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
  78 #endif
  79         tmp_env1 = env_ptr;
  80         crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
  81
  82         if (!crc1_ok && !crc2_ok) {
  83                 gd->env_addr    = 0;
  84                 gd->env_valid   = 0;
  85
  86                 return 0;
  87         } else if (crc1_ok && !crc2_ok) {
  88                 gd->env_valid = ENV_VALID;
  89         }
  90 #ifdef CONFIG_ENV_OFFSET_REDUND
  91         else if (!crc1_ok && crc2_ok) {
  92                 gd->env_valid = ENV_REDUND;
  93         } else {
  94                 /* both ok - check serial */
  95                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
  96                         gd->env_valid = ENV_REDUND;
  97                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
  98                         gd->env_valid = ENV_VALID;
  99                 else if (tmp_env1->flags > tmp_env2->flags)
 100                         gd->env_valid = ENV_VALID;
 101                 else if (tmp_env2->flags > tmp_env1->flags)
 102                         gd->env_valid = ENV_REDUND;
 103                 else /* flags are equal - almost impossible */
 104                         gd->env_valid = ENV_VALID;
 105         }
 106
 107         if (gd->env_valid == ENV_REDUND)
 108                 env_ptr = tmp_env2;
 109         else
 110 #endif
 111         if (gd->env_valid == ENV_VALID)
 112                 env_ptr = tmp_env1;
 113
 114         gd->env_addr = (ulong)env_ptr->data;
 115
 116 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
 117         gd->env_addr    = (ulong)&default_environment[0];
 118         gd->env_valid   = ENV_VALID;
 119 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
 120
 121         return 0;
 122 }
 123
 124 #ifdef CMD_SAVEENV
 125 /*
 126  * The legacy NAND code saved the environment in the first NAND device i.e.,
 127  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
 128  */
 129 static int writeenv(size_t offset, u_char *buf)
 130 {
 131         size_t end = offset + CONFIG_ENV_RANGE;
 132         size_t amount_saved = 0;
 133         size_t blocksize, len;
 134         struct mtd_info *mtd;
 135         u_char *char_ptr;
 136
 137         mtd = get_nand_dev_by_index(0);
 138         if (!mtd)
 139                 return 1;
 140
 141         blocksize = mtd->erasesize;
 142         len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
 143
 144         while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
 145                 if (nand_block_isbad(mtd, offset)) {
 146                         offset += blocksize;
 147                 } else {
 148                         char_ptr = &buf[amount_saved];
 149                         if (nand_write(mtd, offset, &len, char_ptr))
 150                                 return 1;
 151
 152                         offset += blocksize;
 153                         amount_saved += len;
 154                 }
 155         }
 156         if (amount_saved != CONFIG_ENV_SIZE)
 157                 return 1;
 158
 159         return 0;
 160 }
 161
 162 struct nand_env_location {
 163         const char *name;
 164         const nand_erase_options_t erase_opts;
 165 };
 166
 167 static int erase_and_write_env(const struct nand_env_location *location,
 168                 u_char *env_new)
 169 {
 170         struct mtd_info *mtd;
 171         int ret = 0;
 172
 173         mtd = get_nand_dev_by_index(0);
 174         if (!mtd)
 175                 return 1;
 176
 177         printf("Erasing %s...\n", location->name);
 178         if (nand_erase_opts(mtd, &location->erase_opts))
 179                 return 1;
 180
 181         printf("Writing to %s... ", location->name);
 182         ret = writeenv(location->erase_opts.offset, env_new);
 183         puts(ret ? "FAILED!\n" : "OK\n");
 184
 185         return ret;
 186 }
 187
 188 static int env_nand_save(void)
 189 {
 190         int     ret = 0;
 191         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
 192         int     env_idx = 0;
 193         static const struct nand_env_location location[] = {
 194                 {
 195                         .name = "NAND",
 196                         .erase_opts = {
 197                                 .length = CONFIG_ENV_RANGE,
 198                                 .offset = CONFIG_ENV_OFFSET,
 199                         },
 200                 },
 201 #ifdef CONFIG_ENV_OFFSET_REDUND
 202                 {
 203                         .name = "redundant NAND",
 204                         .erase_opts = {
 205                                 .length = CONFIG_ENV_RANGE,
 206                                 .offset = CONFIG_ENV_OFFSET_REDUND,
 207                         },
 208                 },
 209 #endif
 210         };
 211
 212
 213         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
 214                 return 1;
 215
 216         ret = env_export(env_new);
 217         if (ret)
 218                 return ret;
 219
 220 #ifdef CONFIG_ENV_OFFSET_REDUND
 221         env_idx = (gd->env_valid == ENV_VALID);
 222 #endif
 223
 224         ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
 225 #ifdef CONFIG_ENV_OFFSET_REDUND
 226         if (!ret) {
 227                 /* preset other copy for next write */
 228                 gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID :
 229                                 ENV_REDUND;
 230                 return ret;
 231         }
 232
 233         env_idx = (env_idx + 1) & 1;
 234         ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
 235         if (!ret)
 236                 printf("Warning: primary env write failed,"
 237                                 " redundancy is lost!\n");
 238 #endif
 239
 240         return ret;
 241 }
 242 #endif /* CMD_SAVEENV */
 243
 244 #if defined(CONFIG_SPL_BUILD)
 245 static int readenv(size_t offset, u_char *buf)
 246 {
 247         return nand_spl_load_image(offset, CONFIG_ENV_SIZE, buf);
 248 }
 249 #else
 250 static int readenv(size_t offset, u_char *buf)
 251 {
 252         size_t end = offset + CONFIG_ENV_RANGE;
 253         size_t amount_loaded = 0;
 254         size_t blocksize, len;
 255         struct mtd_info *mtd;
 256         u_char *char_ptr;
 257
 258         mtd = get_nand_dev_by_index(0);
 259         if (!mtd)
 260                 return 1;
 261
 262         blocksize = mtd->erasesize;
 263         len = min(blocksize, (size_t)CONFIG_ENV_SIZE);
 264
 265         while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
 266                 if (nand_block_isbad(mtd, offset)) {
 267                         offset += blocksize;
 268                 } else {
 269                         char_ptr = &buf[amount_loaded];
 270                         if (nand_read_skip_bad(mtd, offset,
 271                                                &len, NULL,
 272                                                mtd->size, char_ptr))
 273                                 return 1;
 274
 275                         offset += blocksize;
 276                         amount_loaded += len;
 277                 }
 278         }
 279
 280         if (amount_loaded != CONFIG_ENV_SIZE)
 281                 return 1;
 282
 283         return 0;
 284 }
 285 #endif /* #if defined(CONFIG_SPL_BUILD) */
 286
 287 #ifdef CONFIG_ENV_OFFSET_OOB
 288 int get_nand_env_oob(struct mtd_info *mtd, unsigned long *result)
 289 {
 290         struct mtd_oob_ops ops;
 291         uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
 292         int ret;
 293
 294         ops.datbuf      = NULL;
 295         ops.mode        = MTD_OOB_AUTO;
 296         ops.ooboffs     = 0;
 297         ops.ooblen      = ENV_OFFSET_SIZE;
 298         ops.oobbuf      = (void *)oob_buf;
 299
 300         ret = mtd->read_oob(mtd, ENV_OFFSET_SIZE, &ops);
 301         if (ret) {
 302                 printf("error reading OOB block 0\n");
 303                 return ret;
 304         }
 305
 306         if (oob_buf[0] == ENV_OOB_MARKER) {
 307                 *result = oob_buf[1] * mtd->erasesize;
 308         } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
 309                 *result = oob_buf[1];
 310         } else {
 311                 printf("No dynamic environment marker in OOB block 0\n");
 312                 return -ENOENT;
 313         }
 314
 315         return 0;
 316 }
 317 #endif
 318
 319 #ifdef CONFIG_ENV_OFFSET_REDUND
 320 static void env_nand_load(void)
 321 {
 322 #if !defined(ENV_IS_EMBEDDED)
 323         int read1_fail = 0, read2_fail = 0;
 324         env_t *tmp_env1, *tmp_env2;
 325
 326         tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
 327         tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
 328         if (tmp_env1 == NULL || tmp_env2 == NULL) {
 329                 puts("Can't allocate buffers for environment\n");
 330                 set_default_env("!malloc() failed");
 331                 goto done;
 332         }
 333
 334         read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
 335         read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
 336
 337         if (read1_fail && read2_fail)
 338                 puts("*** Error - No Valid Environment Area found\n");
 339         else if (read1_fail || read2_fail)
 340                 puts("*** Warning - some problems detected "
 341                      "reading environment; recovered successfully\n");
 342
 343         if (read1_fail && read2_fail) {
 344                 set_default_env("!bad env area");
 345                 goto done;
 346         } else if (!read1_fail && read2_fail) {
 347                 gd->env_valid = ENV_VALID;
 348                 env_import((char *)tmp_env1, 1);
 349         } else if (read1_fail && !read2_fail) {
 350                 gd->env_valid = ENV_REDUND;
 351                 env_import((char *)tmp_env2, 1);
 352         } else {
 353                 env_import_redund((char *)tmp_env1, (char *)tmp_env2);
 354         }
 355
 356 done:
 357         free(tmp_env1);
 358         free(tmp_env2);
 359
 360 #endif /* ! ENV_IS_EMBEDDED */
 361 }
 362 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 363 /*
 364  * The legacy NAND code saved the environment in the first NAND
 365  * device i.e., nand_dev_desc + 0. This is also the behaviour using
 366  * the new NAND code.
 367  */
 368 static void env_nand_load(void)
 369 {
 370 #if !defined(ENV_IS_EMBEDDED)
 371         int ret;
 372         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
 373
 374 #if defined(CONFIG_ENV_OFFSET_OOB)
 375         struct mtd_info *mtd  = get_nand_dev_by_index(0);
 376         /*
 377          * If unable to read environment offset from NAND OOB then fall through
 378          * to the normal environment reading code below
 379          */
 380         if (mtd && !get_nand_env_oob(mtd, &nand_env_oob_offset)) {
 381                 printf("Found Environment offset in OOB..\n");
 382         } else {
 383                 set_default_env("!no env offset in OOB");
 384                 return;
 385         }
 386 #endif
 387
 388         ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
 389         if (ret) {
 390                 set_default_env("!readenv() failed");
 391                 return;
 392         }
 393
 394         env_import(buf, 1);
 395 #endif /* ! ENV_IS_EMBEDDED */
 396 }
 397 #endif /* CONFIG_ENV_OFFSET_REDUND */
 398
 399 U_BOOT_ENV_LOCATION(nand) = {
 400         .location       = ENVL_NAND,
 401         .load           = env_nand_load,
 402 #if defined(CMD_SAVEENV)
 403         .save           = env_save_ptr(env_nand_save),
 404 #endif
 405         .init           = env_nand_init,
 406 };