common/env_nand.c

   1 /*
   2  * (C) Copyright 2004
   3  * Jian Zhang, Texas Instruments, jzhang@ti.com.
   4
   5  * (C) Copyright 2000-2004
   6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   7  *
   8  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   9  * Andreas Heppel <aheppel@sysgo.de>
  10
  11  * See file CREDITS for list of people who contributed to this
  12  * project.
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License as
  16  * published by the Free Software Foundation; either version 2 of
  17  * the License, or (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  27  * MA 02111-1307 USA
  28  */
  29
  30 /* #define DEBUG */
  31
  32 #include <common.h>
  33
  34 #if defined(CFG_ENV_IS_IN_NAND) /* Environment is in Nand Flash */
  35
  36 #include <command.h>
  37 #include <environment.h>
  38 #include <linux/stddef.h>
  39 #include <malloc.h>
  40 #include <nand.h>
  41
  42 #if ((CONFIG_COMMANDS&(CFG_CMD_ENV|CFG_CMD_NAND)) == (CFG_CMD_ENV|CFG_CMD_NAND))
  43 #define CMD_SAVEENV
  44 #elif defined(CFG_ENV_OFFSET_REDUND)
  45 #error Cannot use CFG_ENV_OFFSET_REDUND without CFG_CMD_ENV & CFG_CMD_NAND
  46 #endif
  47
  48 #if defined(CFG_ENV_SIZE_REDUND) && (CFG_ENV_SIZE_REDUND != CFG_ENV_SIZE)
  49 #error CFG_ENV_SIZE_REDUND should be the same as CFG_ENV_SIZE
  50 #endif
  51
  52 #ifdef CONFIG_INFERNO
  53 #error CONFIG_INFERNO not supported yet
  54 #endif
  55
  56 int nand_legacy_rw (struct nand_chip* nand, int cmd,
  57             size_t start, size_t len,
  58             size_t * retlen, u_char * buf);
  59
  60 /* info for NAND chips, defined in drivers/nand/nand.c */
  61 extern nand_info_t nand_info[];
  62
  63 /* references to names in env_common.c */
  64 extern uchar default_environment[];
  65 extern int default_environment_size;
  66
  67 char * env_name_spec = "NAND";
  68
  69
  70 #ifdef ENV_IS_EMBEDDED
  71 extern uchar environment[];
  72 env_t *env_ptr = (env_t *)(&environment[0]);
  73 #else /* ! ENV_IS_EMBEDDED */
  74 env_t *env_ptr = 0;
  75 #endif /* ENV_IS_EMBEDDED */
  76
  77
  78 /* local functions */
  79 static void use_default(void);
  80
  81
  82 uchar env_get_char_spec (int index)
  83 {
  84         DECLARE_GLOBAL_DATA_PTR;
  85
  86         return ( *((uchar *)(gd->env_addr + index)) );
  87 }
  88
  89
  90 /* this is called before nand_init()
  91  * so we can't read Nand to validate env data.
  92  * Mark it OK for now. env_relocate() in env_common.c
  93  * will call our relocate function which will does
  94  * the real validation.
  95  */
  96 int env_init(void)
  97 {
  98         DECLARE_GLOBAL_DATA_PTR;
  99
 100         gd->env_addr  = (ulong)&default_environment[0];
 101         gd->env_valid = 1;
 102
 103         return (0);
 104 }
 105
 106 #ifdef CMD_SAVEENV
 107 /*
 108  * The legacy NAND code saved the environment in the first NAND device i.e.,
 109  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
 110  */
 111 #ifdef CFG_ENV_OFFSET_REDUND
 112 int saveenv(void)
 113 {
 114         ulong total;
 115         int ret = 0;
 116
 117         DECLARE_GLOBAL_DATA_PTR;
 118
 119         env_ptr->flags++;
 120         total = CFG_ENV_SIZE;
 121
 122         if(gd->env_valid == 1) {
 123                 puts ("Erasing redundant Nand...");
 124                 if (nand_erase(&nand_info[0],
 125                                CFG_ENV_OFFSET_REDUND, CFG_ENV_SIZE))
 126                         return 1;
 127                 puts ("Writing to redundant Nand... ");
 128                 ret = nand_write(&nand_info[0], CFG_ENV_OFFSET_REDUND, &total,
 129                                  (u_char*) env_ptr);
 130         } else {
 131                 puts ("Erasing Nand...");
 132                 if (nand_erase(&nand_info[0],
 133                                CFG_ENV_OFFSET, CFG_ENV_SIZE))
 134                         return 1;
 135
 136                 puts ("Writing to Nand... ");
 137                 ret = nand_write(&nand_info[0], CFG_ENV_OFFSET, &total,
 138                                  (u_char*) env_ptr);
 139         }
 140         if (ret || total != CFG_ENV_SIZE)
 141                 return 1;
 142
 143         puts ("done\n");
 144         gd->env_valid = (gd->env_valid == 2 ? 1 : 2);
 145         return ret;
 146 }
 147 #else /* ! CFG_ENV_OFFSET_REDUND */
 148 int saveenv(void)
 149 {
 150         ulong total;
 151         int ret = 0;
 152
 153         puts ("Erasing Nand...");
 154         if (nand_erase(&nand_info[0], CFG_ENV_OFFSET, CFG_ENV_SIZE))
 155                 return 1;
 156
 157         puts ("Writing to Nand... ");
 158         total = CFG_ENV_SIZE;
 159         ret = nand_write(&nand_info[0], CFG_ENV_OFFSET, &total, (u_char*)env_ptr);
 160         if (ret || total != CFG_ENV_SIZE)
 161                 return 1;
 162
 163         puts ("done\n");
 164         return ret;
 165 }
 166 #endif /* CFG_ENV_OFFSET_REDUND */
 167 #endif /* CMD_SAVEENV */
 168
 169 #ifdef CFG_ENV_OFFSET_REDUND
 170 void env_relocate_spec (void)
 171 {
 172 #if !defined(ENV_IS_EMBEDDED)
 173         ulong total;
 174         int crc1_ok = 0, crc2_ok = 0;
 175         env_t *tmp_env1, *tmp_env2;
 176
 177         DECLARE_GLOBAL_DATA_PTR;
 178
 179         total = CFG_ENV_SIZE;
 180
 181         tmp_env1 = (env_t *) malloc(CFG_ENV_SIZE);
 182         tmp_env2 = (env_t *) malloc(CFG_ENV_SIZE);
 183
 184         nand_read(&nand_info[0], CFG_ENV_OFFSET, &total,
 185                   (u_char*) tmp_env1);
 186         nand_read(&nand_info[0], CFG_ENV_OFFSET_REDUND, &total,
 187                   (u_char*) tmp_env2);
 188
 189         crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
 190         crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
 191
 192         if(!crc1_ok && !crc2_ok)
 193                 return use_default();
 194         else if(crc1_ok && !crc2_ok)
 195                 gd->env_valid = 1;
 196         else if(!crc1_ok && crc2_ok)
 197                 gd->env_valid = 2;
 198         else {
 199                 /* both ok - check serial */
 200                 if(tmp_env1->flags == 255 && tmp_env2->flags == 0)
 201                         gd->env_valid = 2;
 202                 else if(tmp_env2->flags == 255 && tmp_env1->flags == 0)
 203                         gd->env_valid = 1;
 204                 else if(tmp_env1->flags > tmp_env2->flags)
 205                         gd->env_valid = 1;
 206                 else if(tmp_env2->flags > tmp_env1->flags)
 207                         gd->env_valid = 2;
 208                 else /* flags are equal - almost impossible */
 209                         gd->env_valid = 1;
 210
 211         }
 212
 213         free(env_ptr);
 214         if(gd->env_valid == 1) {
 215                 env_ptr = tmp_env1;
 216                 free(tmp_env2);
 217         } else {
 218                 env_ptr = tmp_env2;
 219                 free(tmp_env1);
 220         }
 221
 222 #endif /* ! ENV_IS_EMBEDDED */
 223 }
 224 #else /* ! CFG_ENV_OFFSET_REDUND */
 225 /*
 226  * The legacy NAND code saved the environment in the first NAND device i.e.,
 227  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
 228  */
 229 void env_relocate_spec (void)
 230 {
 231 #if !defined(ENV_IS_EMBEDDED)
 232         ulong total;
 233         int ret;
 234
 235         total = CFG_ENV_SIZE;
 236         ret = nand_read(&nand_info[0], CFG_ENV_OFFSET, &total, (u_char*)env_ptr);
 237         if (ret || total != CFG_ENV_SIZE)
 238                 return use_default();
 239
 240         if (crc32(0, env_ptr->data, ENV_SIZE) != env_ptr->crc)
 241                 return use_default();
 242 #endif /* ! ENV_IS_EMBEDDED */
 243 }
 244 #endif /* CFG_ENV_OFFSET_REDUND */
 245
 246 static void use_default()
 247 {
 248         DECLARE_GLOBAL_DATA_PTR;
 249
 250         puts ("*** Warning - bad CRC or NAND, using default environment\n\n");
 251
 252         if (default_environment_size > CFG_ENV_SIZE){
 253                 puts ("*** Error - default environment is too large\n\n");
 254                 return;
 255         }
 256
 257         memset (env_ptr, 0, sizeof(env_t));
 258         memcpy (env_ptr->data,
 259                         default_environment,
 260                         default_environment_size);
 261         env_ptr->crc = crc32(0, env_ptr->data, ENV_SIZE);
 262         gd->env_valid = 1;
 263
 264 }
 265
 266 #endif /* CFG_ENV_IS_IN_NAND */