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