common/env_flash.c

   1 /*
   2  * (C) Copyright 2000-2002
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   6  * Andreas Heppel <aheppel@sysgo.de>
   7
   8  * See file CREDITS for list of people who contributed to this
   9  * project.
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; either version 2 of
  14  * the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  24  * MA 02111-1307 USA
  25  */
  26
  27 /* #define DEBUG */
  28
  29 #include <common.h>
  30 #include <command.h>
  31 #include <environment.h>
  32 #include <linux/stddef.h>
  33 #include <malloc.h>
  34
  35 DECLARE_GLOBAL_DATA_PTR;
  36
  37 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_FLASH)
  38 #define CMD_SAVEENV
  39 #elif defined(CONFIG_ENV_ADDR_REDUND)
  40 #error Cannot use CONFIG_ENV_ADDR_REDUND without CONFIG_CMD_SAVEENV & CONFIG_CMD_FLASH
  41 #endif
  42
  43 #if defined(CONFIG_ENV_SIZE_REDUND) && (CONFIG_ENV_SIZE_REDUND < CONFIG_ENV_SIZE)
  44 #error CONFIG_ENV_SIZE_REDUND should not be less then CONFIG_ENV_SIZE
  45 #endif
  46
  47 char * env_name_spec = "Flash";
  48
  49 #ifdef ENV_IS_EMBEDDED
  50
  51 extern uchar environment[];
  52 env_t *env_ptr = (env_t *)(&environment[0]);
  53
  54 #ifdef CMD_SAVEENV
  55 /* static env_t *flash_addr = (env_t *)(&environment[0]);-broken on ARM-wd-*/
  56 static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
  57 #endif
  58
  59 #else /* ! ENV_IS_EMBEDDED */
  60
  61 env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
  62 #ifdef CMD_SAVEENV
  63 static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
  64 #endif
  65
  66 #endif /* ENV_IS_EMBEDDED */
  67
  68 #ifdef CONFIG_ENV_ADDR_REDUND
  69 static env_t *flash_addr_new = (env_t *)CONFIG_ENV_ADDR_REDUND;
  70
  71 /* CONFIG_ENV_ADDR is supposed to be on sector boundary */
  72 static ulong end_addr = CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1;
  73 static ulong end_addr_new = CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1;
  74
  75 #define ACTIVE_FLAG   1
  76 #define OBSOLETE_FLAG 0
  77 #endif /* CONFIG_ENV_ADDR_REDUND */
  78
  79 extern uchar default_environment[];
  80
  81
  82 uchar env_get_char_spec (int index)
  83 {
  84         return ( *((uchar *)(gd->env_addr + index)) );
  85 }
  86
  87 #ifdef CONFIG_ENV_ADDR_REDUND
  88
  89 int  env_init(void)
  90 {
  91         int crc1_ok = 0, crc2_ok = 0;
  92
  93         uchar flag1 = flash_addr->flags;
  94         uchar flag2 = flash_addr_new->flags;
  95
  96         ulong addr_default = (ulong)&default_environment[0];
  97         ulong addr1 = (ulong)&(flash_addr->data);
  98         ulong addr2 = (ulong)&(flash_addr_new->data);
  99
 100         crc1_ok = (crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc);
 101         crc2_ok = (crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc);
 102
 103         if (crc1_ok && ! crc2_ok) {
 104                 gd->env_addr  = addr1;
 105                 gd->env_valid = 1;
 106         } else if (! crc1_ok && crc2_ok) {
 107                 gd->env_addr  = addr2;
 108                 gd->env_valid = 1;
 109         } else if (! crc1_ok && ! crc2_ok) {
 110                 gd->env_addr  = addr_default;
 111                 gd->env_valid = 0;
 112         } else if (flag1 == ACTIVE_FLAG && flag2 == OBSOLETE_FLAG) {
 113                 gd->env_addr  = addr1;
 114                 gd->env_valid = 1;
 115         } else if (flag1 == OBSOLETE_FLAG && flag2 == ACTIVE_FLAG) {
 116                 gd->env_addr  = addr2;
 117                 gd->env_valid = 1;
 118         } else if (flag1 == flag2) {
 119                 gd->env_addr  = addr1;
 120                 gd->env_valid = 2;
 121         } else if (flag1 == 0xFF) {
 122                 gd->env_addr  = addr1;
 123                 gd->env_valid = 2;
 124         } else if (flag2 == 0xFF) {
 125                 gd->env_addr  = addr2;
 126                 gd->env_valid = 2;
 127         }
 128
 129         return (0);
 130 }
 131
 132 #ifdef CMD_SAVEENV
 133 int saveenv(void)
 134 {
 135         char *saved_data = NULL;
 136         int rc = 1;
 137         char flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
 138 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 139         ulong up_data = 0;
 140 #endif
 141
 142         debug ("Protect off %08lX ... %08lX\n",
 143                 (ulong)flash_addr, end_addr);
 144
 145         if (flash_sect_protect (0, (ulong)flash_addr, end_addr)) {
 146                 goto Done;
 147         }
 148
 149         debug ("Protect off %08lX ... %08lX\n",
 150                 (ulong)flash_addr_new, end_addr_new);
 151
 152         if (flash_sect_protect (0, (ulong)flash_addr_new, end_addr_new)) {
 153                 goto Done;
 154         }
 155
 156 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 157         up_data = (end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE));
 158         debug ("Data to save 0x%x\n", up_data);
 159         if (up_data) {
 160                 if ((saved_data = malloc(up_data)) == NULL) {
 161                         printf("Unable to save the rest of sector (%ld)\n",
 162                                 up_data);
 163                         goto Done;
 164                 }
 165                 memcpy(saved_data,
 166                         (void *)((long)flash_addr_new + CONFIG_ENV_SIZE), up_data);
 167                 debug ("Data (start 0x%x, len 0x%x) saved at 0x%x\n",
 168                            (long)flash_addr_new + CONFIG_ENV_SIZE,
 169                                 up_data, saved_data);
 170         }
 171 #endif
 172         puts ("Erasing Flash...");
 173         debug (" %08lX ... %08lX ...",
 174                 (ulong)flash_addr_new, end_addr_new);
 175
 176         if (flash_sect_erase ((ulong)flash_addr_new, end_addr_new)) {
 177                 goto Done;
 178         }
 179
 180         puts ("Writing to Flash... ");
 181         debug (" %08lX ... %08lX ...",
 182                 (ulong)&(flash_addr_new->data),
 183                 sizeof(env_ptr->data)+(ulong)&(flash_addr_new->data));
 184         if ((rc = flash_write((char *)env_ptr->data,
 185                         (ulong)&(flash_addr_new->data),
 186                         sizeof(env_ptr->data))) ||
 187             (rc = flash_write((char *)&(env_ptr->crc),
 188                         (ulong)&(flash_addr_new->crc),
 189                         sizeof(env_ptr->crc))) ||
 190             (rc = flash_write(&flag,
 191                         (ulong)&(flash_addr->flags),
 192                         sizeof(flash_addr->flags))) ||
 193             (rc = flash_write(&new_flag,
 194                         (ulong)&(flash_addr_new->flags),
 195                         sizeof(flash_addr_new->flags))))
 196         {
 197                 flash_perror (rc);
 198                 goto Done;
 199         }
 200         puts ("done\n");
 201
 202 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 203         if (up_data) { /* restore the rest of sector */
 204                 debug ("Restoring the rest of data to 0x%x len 0x%x\n",
 205                            (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
 206                 if (flash_write(saved_data,
 207                                 (long)flash_addr_new + CONFIG_ENV_SIZE,
 208                                 up_data)) {
 209                         flash_perror(rc);
 210                         goto Done;
 211                 }
 212         }
 213 #endif
 214         {
 215                 env_t * etmp = flash_addr;
 216                 ulong ltmp = end_addr;
 217
 218                 flash_addr = flash_addr_new;
 219                 flash_addr_new = etmp;
 220
 221                 end_addr = end_addr_new;
 222                 end_addr_new = ltmp;
 223         }
 224
 225         rc = 0;
 226 Done:
 227
 228         if (saved_data)
 229                 free (saved_data);
 230         /* try to re-protect */
 231         (void) flash_sect_protect (1, (ulong)flash_addr, end_addr);
 232         (void) flash_sect_protect (1, (ulong)flash_addr_new, end_addr_new);
 233
 234         return rc;
 235 }
 236 #endif /* CMD_SAVEENV */
 237
 238 #else /* ! CONFIG_ENV_ADDR_REDUND */
 239
 240 int  env_init(void)
 241 {
 242         if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
 243                 gd->env_addr  = (ulong)&(env_ptr->data);
 244                 gd->env_valid = 1;
 245                 return(0);
 246         }
 247
 248         gd->env_addr  = (ulong)&default_environment[0];
 249         gd->env_valid = 0;
 250         return (0);
 251 }
 252
 253 #ifdef CMD_SAVEENV
 254
 255 int saveenv(void)
 256 {
 257         int     len, rc;
 258         ulong   end_addr;
 259         ulong   flash_sect_addr;
 260 #if defined(CONFIG_ENV_SECT_SIZE) && (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE)
 261         ulong   flash_offset;
 262         uchar   env_buffer[CONFIG_ENV_SECT_SIZE];
 263 #else
 264         uchar *env_buffer = (uchar *)env_ptr;
 265 #endif  /* CONFIG_ENV_SECT_SIZE */
 266         int rcode = 0;
 267
 268 #if defined(CONFIG_ENV_SECT_SIZE) && (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE)
 269
 270         flash_offset    = ((ulong)flash_addr) & (CONFIG_ENV_SECT_SIZE-1);
 271         flash_sect_addr = ((ulong)flash_addr) & ~(CONFIG_ENV_SECT_SIZE-1);
 272
 273         debug ( "copy old content: "
 274                 "sect_addr: %08lX  env_addr: %08lX  offset: %08lX\n",
 275                 flash_sect_addr, (ulong)flash_addr, flash_offset);
 276
 277         /* copy old contents to temporary buffer */
 278         memcpy (env_buffer, (void *)flash_sect_addr, CONFIG_ENV_SECT_SIZE);
 279
 280         /* copy current environment to temporary buffer */
 281         memcpy ((uchar *)((unsigned long)env_buffer + flash_offset),
 282                 env_ptr,
 283                 CONFIG_ENV_SIZE);
 284
 285         len      = CONFIG_ENV_SECT_SIZE;
 286 #else
 287         flash_sect_addr = (ulong)flash_addr;
 288         len      = CONFIG_ENV_SIZE;
 289 #endif  /* CONFIG_ENV_SECT_SIZE */
 290
 291         end_addr = flash_sect_addr + len - 1;
 292
 293         debug ("Protect off %08lX ... %08lX\n",
 294                 (ulong)flash_sect_addr, end_addr);
 295
 296         if (flash_sect_protect (0, flash_sect_addr, end_addr))
 297                 return 1;
 298
 299         puts ("Erasing Flash...");
 300         if (flash_sect_erase (flash_sect_addr, end_addr))
 301                 return 1;
 302
 303         puts ("Writing to Flash... ");
 304         rc = flash_write((char *)env_buffer, flash_sect_addr, len);
 305         if (rc != 0) {
 306                 flash_perror (rc);
 307                 rcode = 1;
 308         } else {
 309                 puts ("done\n");
 310         }
 311
 312         /* try to re-protect */
 313         (void) flash_sect_protect (1, flash_sect_addr, end_addr);
 314         return rcode;
 315 }
 316
 317 #endif /* CMD_SAVEENV */
 318
 319 #endif /* CONFIG_ENV_ADDR_REDUND */
 320
 321 void env_relocate_spec (void)
 322 {
 323 #if !defined(ENV_IS_EMBEDDED) || defined(CONFIG_ENV_ADDR_REDUND)
 324 #ifdef CONFIG_ENV_ADDR_REDUND
 325         if (gd->env_addr != (ulong)&(flash_addr->data)) {
 326                 env_t * etmp = flash_addr;
 327                 ulong ltmp = end_addr;
 328
 329                 flash_addr = flash_addr_new;
 330                 flash_addr_new = etmp;
 331
 332                 end_addr = end_addr_new;
 333                 end_addr_new = ltmp;
 334         }
 335
 336         if (flash_addr_new->flags != OBSOLETE_FLAG &&
 337             crc32(0, flash_addr_new->data, ENV_SIZE) ==
 338             flash_addr_new->crc) {
 339                 char flag = OBSOLETE_FLAG;
 340
 341                 gd->env_valid = 2;
 342                 flash_sect_protect (0, (ulong)flash_addr_new, end_addr_new);
 343                 flash_write(&flag,
 344                             (ulong)&(flash_addr_new->flags),
 345                             sizeof(flash_addr_new->flags));
 346                 flash_sect_protect (1, (ulong)flash_addr_new, end_addr_new);
 347         }
 348
 349         if (flash_addr->flags != ACTIVE_FLAG &&
 350             (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG) {
 351                 char flag = ACTIVE_FLAG;
 352
 353                 gd->env_valid = 2;
 354                 flash_sect_protect (0, (ulong)flash_addr, end_addr);
 355                 flash_write(&flag,
 356                             (ulong)&(flash_addr->flags),
 357                             sizeof(flash_addr->flags));
 358                 flash_sect_protect (1, (ulong)flash_addr, end_addr);
 359         }
 360
 361         if (gd->env_valid == 2)
 362                 puts ("*** Warning - some problems detected "
 363                       "reading environment; recovered successfully\n\n");
 364 #endif /* CONFIG_ENV_ADDR_REDUND */
 365 #ifdef CMD_SAVEENV
 366         memcpy (env_ptr, (void*)flash_addr, CONFIG_ENV_SIZE);
 367 #endif
 368 #endif /* ! ENV_IS_EMBEDDED || CONFIG_ENV_ADDR_REDUND */
 369 }