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