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