common/env_nand.c

   1 /*
   2  * (C) Copyright 2008
   3  * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
   4  *
   5  * (C) Copyright 2004
   6  * Jian Zhang, Texas Instruments, jzhang@ti.com.
   7
   8  * (C) Copyright 2000-2006
   9  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  10  *
  11  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
  12  * Andreas Heppel <aheppel@sysgo.de>
  13
  14  * See file CREDITS for list of people who contributed to this
  15  * project.
  16  *
  17  * This program is free software; you can redistribute it and/or
  18  * modify it under the terms of the GNU General Public License as
  19  * published by the Free Software Foundation; either version 2 of
  20  * the License, or (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program; if not, write to the Free Software
  29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  30  * MA 02111-1307 USA
  31  */
  32
  33 /* #define DEBUG */
  34
  35 #include <common.h>
  36 #include <command.h>
  37 #include <environment.h>
  38 #include <linux/stddef.h>
  39 #include <malloc.h>
  40 #include <nand.h>
  41
  42 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
  43 #define CMD_SAVEENV
  44 #elif defined(CONFIG_ENV_OFFSET_REDUND)
  45 #error Cannot use CONFIG_ENV_OFFSET_REDUND without CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
  46 #endif
  47
  48 #if defined(CONFIG_ENV_SIZE_REDUND) && (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
  49 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
  50 #endif
  51
  52 #ifdef CONFIG_INFERNO
  53 #error CONFIG_INFERNO not supported yet
  54 #endif
  55
  56 #ifndef CONFIG_ENV_RANGE
  57 #define CONFIG_ENV_RANGE        CONFIG_ENV_SIZE
  58 #endif
  59
  60 int nand_legacy_rw (struct nand_chip* nand, int cmd,
  61             size_t start, size_t len,
  62             size_t * retlen, u_char * buf);
  63
  64 /* references to names in env_common.c */
  65 extern uchar default_environment[];
  66 extern int default_environment_size;
  67
  68 char * env_name_spec = "NAND";
  69
  70
  71 #if defined(ENV_IS_EMBEDDED)
  72 extern uchar environment[];
  73 env_t *env_ptr = (env_t *)(&environment[0]);
  74 #elif defined(CONFIG_NAND_ENV_DST)
  75 env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
  76 #else /* ! ENV_IS_EMBEDDED */
  77 env_t *env_ptr = 0;
  78 #endif /* ENV_IS_EMBEDDED */
  79
  80
  81 /* local functions */
  82 #if !defined(ENV_IS_EMBEDDED)
  83 static void use_default(void);
  84 #endif
  85
  86 DECLARE_GLOBAL_DATA_PTR;
  87
  88 uchar env_get_char_spec (int index)
  89 {
  90         return ( *((uchar *)(gd->env_addr + index)) );
  91 }
  92
  93
  94 /* this is called before nand_init()
  95  * so we can't read Nand to validate env data.
  96  * Mark it OK for now. env_relocate() in env_common.c
  97  * will call our relocate function which does the real
  98  * validation.
  99  *
 100  * When using a NAND boot image (like sequoia_nand), the environment
 101  * can be embedded or attached to the U-Boot image in NAND flash. This way
 102  * the SPL loads not only the U-Boot image from NAND but also the
 103  * environment.
 104  */
 105 int env_init(void)
 106 {
 107 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
 108         int crc1_ok = 0, crc2_ok = 0;
 109         env_t *tmp_env1;
 110
 111 #ifdef CONFIG_ENV_OFFSET_REDUND
 112         env_t *tmp_env2;
 113
 114         tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
 115         crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
 116 #endif
 117
 118         tmp_env1 = env_ptr;
 119
 120         crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
 121
 122         if (!crc1_ok && !crc2_ok) {
 123                 gd->env_addr  = 0;
 124                 gd->env_valid = 0;
 125
 126                 return 0;
 127         } else if (crc1_ok && !crc2_ok) {
 128                 gd->env_valid = 1;
 129         }
 130 #ifdef CONFIG_ENV_OFFSET_REDUND
 131         else if (!crc1_ok && crc2_ok) {
 132                 gd->env_valid = 2;
 133         } else {
 134                 /* both ok - check serial */
 135                 if(tmp_env1->flags == 255 && tmp_env2->flags == 0)
 136                         gd->env_valid = 2;
 137                 else if(tmp_env2->flags == 255 && tmp_env1->flags == 0)
 138                         gd->env_valid = 1;
 139                 else if(tmp_env1->flags > tmp_env2->flags)
 140                         gd->env_valid = 1;
 141                 else if(tmp_env2->flags > tmp_env1->flags)
 142                         gd->env_valid = 2;
 143                 else /* flags are equal - almost impossible */
 144                         gd->env_valid = 1;
 145         }
 146
 147         if (gd->env_valid == 2)
 148                 env_ptr = tmp_env2;
 149         else
 150 #endif
 151         if (gd->env_valid == 1)
 152                 env_ptr = tmp_env1;
 153
 154         gd->env_addr = (ulong)env_ptr->data;
 155
 156 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
 157         gd->env_addr  = (ulong)&default_environment[0];
 158         gd->env_valid = 1;
 159 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
 160
 161         return (0);
 162 }
 163
 164 #ifdef CMD_SAVEENV
 165 /*
 166  * The legacy NAND code saved the environment in the first NAND device i.e.,
 167  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
 168  */
 169 int writeenv(size_t offset, u_char *buf)
 170 {
 171         size_t end = offset + CONFIG_ENV_RANGE;
 172         size_t amount_saved = 0;
 173         size_t blocksize, len;
 174
 175         u_char *char_ptr;
 176
 177         blocksize = nand_info[0].erasesize;
 178         len = min(blocksize, CONFIG_ENV_SIZE);
 179
 180         while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
 181                 if (nand_block_isbad(&nand_info[0], offset)) {
 182                         offset += blocksize;
 183                 } else {
 184                         char_ptr = &buf[amount_saved];
 185                         if (nand_write(&nand_info[0], offset, &len,
 186                                         char_ptr))
 187                                 return 1;
 188                         offset += blocksize;
 189                         amount_saved += len;
 190                 }
 191         }
 192         if (amount_saved != CONFIG_ENV_SIZE)
 193                 return 1;
 194
 195         return 0;
 196 }
 197 #ifdef CONFIG_ENV_OFFSET_REDUND
 198 int saveenv(void)
 199 {
 200         int ret = 0;
 201         nand_erase_options_t nand_erase_options;
 202
 203         env_ptr->flags++;
 204
 205         nand_erase_options.length = CONFIG_ENV_RANGE;
 206         nand_erase_options.quiet = 0;
 207         nand_erase_options.jffs2 = 0;
 208         nand_erase_options.scrub = 0;
 209
 210         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
 211                 return 1;
 212         if(gd->env_valid == 1) {
 213                 puts ("Erasing redundant Nand...\n");
 214                 nand_erase_options.offset = CONFIG_ENV_OFFSET_REDUND;
 215                 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
 216                         return 1;
 217
 218                 puts ("Writing to redundant Nand... ");
 219                 ret = writeenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) env_ptr);
 220         } else {
 221                 puts ("Erasing Nand...\n");
 222                 nand_erase_options.offset = CONFIG_ENV_OFFSET;
 223                 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
 224                         return 1;
 225
 226                 puts ("Writing to Nand... ");
 227                 ret = writeenv(CONFIG_ENV_OFFSET, (u_char *) env_ptr);
 228         }
 229         if (ret) {
 230                 puts("FAILED!\n");
 231                 return 1;
 232         }
 233
 234         puts ("done\n");
 235         gd->env_valid = (gd->env_valid == 2 ? 1 : 2);
 236         return ret;
 237 }
 238 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 239 int saveenv(void)
 240 {
 241         int ret = 0;
 242         nand_erase_options_t nand_erase_options;
 243
 244         nand_erase_options.length = CONFIG_ENV_RANGE;
 245         nand_erase_options.quiet = 0;
 246         nand_erase_options.jffs2 = 0;
 247         nand_erase_options.scrub = 0;
 248         nand_erase_options.offset = CONFIG_ENV_OFFSET;
 249
 250         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
 251                 return 1;
 252         puts ("Erasing Nand...\n");
 253         if (nand_erase_opts(&nand_info[0], &nand_erase_options))
 254                 return 1;
 255
 256         puts ("Writing to Nand... ");
 257         if (writeenv(CONFIG_ENV_OFFSET, (u_char *) env_ptr)) {
 258                 puts("FAILED!\n");
 259                 return 1;
 260         }
 261
 262         puts ("done\n");
 263         return ret;
 264 }
 265 #endif /* CONFIG_ENV_OFFSET_REDUND */
 266 #endif /* CMD_SAVEENV */
 267
 268 int readenv (size_t offset, u_char * buf)
 269 {
 270         size_t end = offset + CONFIG_ENV_RANGE;
 271         size_t amount_loaded = 0;
 272         size_t blocksize, len;
 273
 274         u_char *char_ptr;
 275
 276         blocksize = nand_info[0].erasesize;
 277         len = min(blocksize, CONFIG_ENV_SIZE);
 278
 279         while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
 280                 if (nand_block_isbad(&nand_info[0], offset)) {
 281                         offset += blocksize;
 282                 } else {
 283                         char_ptr = &buf[amount_loaded];
 284                         if (nand_read(&nand_info[0], offset, &len, char_ptr))
 285                                 return 1;
 286                         offset += blocksize;
 287                         amount_loaded += len;
 288                 }
 289         }
 290         if (amount_loaded != CONFIG_ENV_SIZE)
 291                 return 1;
 292
 293         return 0;
 294 }
 295
 296 #ifdef CONFIG_ENV_OFFSET_REDUND
 297 void env_relocate_spec (void)
 298 {
 299 #if !defined(ENV_IS_EMBEDDED)
 300         int crc1_ok = 0, crc2_ok = 0;
 301         env_t *tmp_env1, *tmp_env2;
 302
 303         tmp_env1 = (env_t *) malloc(CONFIG_ENV_SIZE);
 304         tmp_env2 = (env_t *) malloc(CONFIG_ENV_SIZE);
 305
 306         if (readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1))
 307                 puts("No Valid Environment Area Found\n");
 308         if (readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2))
 309                 puts("No Valid Reundant Environment Area Found\n");
 310
 311         crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
 312         crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
 313
 314         if(!crc1_ok && !crc2_ok) {
 315                 free(tmp_env1);
 316                 free(tmp_env2);
 317                 return use_default();
 318         } else if(crc1_ok && !crc2_ok)
 319                 gd->env_valid = 1;
 320         else if(!crc1_ok && crc2_ok)
 321                 gd->env_valid = 2;
 322         else {
 323                 /* both ok - check serial */
 324                 if(tmp_env1->flags == 255 && tmp_env2->flags == 0)
 325                         gd->env_valid = 2;
 326                 else if(tmp_env2->flags == 255 && tmp_env1->flags == 0)
 327                         gd->env_valid = 1;
 328                 else if(tmp_env1->flags > tmp_env2->flags)
 329                         gd->env_valid = 1;
 330                 else if(tmp_env2->flags > tmp_env1->flags)
 331                         gd->env_valid = 2;
 332                 else /* flags are equal - almost impossible */
 333                         gd->env_valid = 1;
 334
 335         }
 336
 337         free(env_ptr);
 338         if(gd->env_valid == 1) {
 339                 env_ptr = tmp_env1;
 340                 free(tmp_env2);
 341         } else {
 342                 env_ptr = tmp_env2;
 343                 free(tmp_env1);
 344         }
 345
 346 #endif /* ! ENV_IS_EMBEDDED */
 347 }
 348 #else /* ! CONFIG_ENV_OFFSET_REDUND */
 349 /*
 350  * The legacy NAND code saved the environment in the first NAND device i.e.,
 351  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
 352  */
 353 void env_relocate_spec (void)
 354 {
 355 #if !defined(ENV_IS_EMBEDDED)
 356         int ret;
 357
 358         ret = readenv(CONFIG_ENV_OFFSET, (u_char *) env_ptr);
 359         if (ret)
 360                 return use_default();
 361
 362         if (crc32(0, env_ptr->data, ENV_SIZE) != env_ptr->crc)
 363                 return use_default();
 364 #endif /* ! ENV_IS_EMBEDDED */
 365 }
 366 #endif /* CONFIG_ENV_OFFSET_REDUND */
 367
 368 #if !defined(ENV_IS_EMBEDDED)
 369 static void use_default()
 370 {
 371         puts ("*** Warning - bad CRC or NAND, using default environment\n\n");
 372         set_default_env();
 373 }
 374 #endif