u-boot/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
  31 #if defined(CFG_ENV_IS_IN_FLASH) /* Environment is in Flash */
  32
  33 #include <command.h>
  34 #include <environment.h>
  35 #include <linux/stddef.h>
  36 #include <malloc.h>
  37
  38 DECLARE_GLOBAL_DATA_PTR;
  39
  40 #if ((CONFIG_COMMANDS & (CFG_CMD_ENV | CFG_CMD_FLASH)) == (CFG_CMD_ENV | CFG_CMD_FLASH))
  41         #define CMD_SAVEENV
  42 #elif defined(CFG_ENV_ADDR_REDUND)
  43         #error Cannot use CFG_ENV_ADDR_REDUND without CFG_CMD_ENV & CFG_CMD_FLASH
  44 #endif
  45
  46 #if defined(CFG_ENV_SIZE_REDUND) && (CFG_ENV_SIZE_REDUND < CFG_ENV_SIZE)
  47         #error CFG_ENV_SIZE_REDUND should not be less then CFG_ENV_SIZE
  48 #endif
  49
  50 #ifdef CONFIG_INFERNO
  51         #ifdef CFG_ENV_ADDR_REDUND
  52                 #error CFG_ENV_ADDR_REDUND is not implemented for CONFIG_INFERNO
  53         #endif
  54 #endif
  55
  56 char *env_name_spec = "flash";
  57
  58 #ifdef ENV_IS_EMBEDDED
  59
  60 extern uchar environment[];
  61 env_t *env_ptr = (env_t *)(&environment[0]);
  62
  63 #ifdef CMD_SAVEENV
  64 /* static env_t *flash_addr = (env_t *)(&environment[0]);-broken on ARM-wd-*/
  65 static env_t *flash_addr = (env_t *)CFG_ENV_ADDR;
  66 #endif
  67
  68 #else /* ! ENV_IS_EMBEDDED */
  69
  70 env_t *env_ptr = (env_t *)CFG_ENV_ADDR;
  71
  72 #ifdef CMD_SAVEENV
  73 static env_t *flash_addr = (env_t *)CFG_ENV_ADDR;
  74 #endif
  75
  76 #endif /* ENV_IS_EMBEDDED */
  77
  78 #ifdef CFG_ENV_ADDR_REDUND
  79 static env_t *flash_addr_new = (env_t *)CFG_ENV_ADDR_REDUND;
  80
  81 /* CFG_ENV_ADDR is supposed to be on sector boundary */
  82 static ulong end_addr = CFG_ENV_ADDR + CFG_ENV_SECT_SIZE - 1;
  83 static ulong end_addr_new = CFG_ENV_ADDR_REDUND + CFG_ENV_SECT_SIZE - 1;
  84
  85 #define ACTIVE_FLAG   1
  86 #define OBSOLETE_FLAG 0
  87 #endif /* CFG_ENV_ADDR_REDUND */
  88
  89 extern uchar default_environment[];
  90 extern int default_environment_size;
  91
  92 uchar env_get_char_spec(int index){
  93         return(*((uchar *)(gd->env_addr + index)));
  94 }
  95
  96 #ifdef CFG_ENV_ADDR_REDUND
  97
  98 int env_init(void){
  99         int crc1_ok = 0, crc2_ok = 0;
 100
 101         uchar flag1 = flash_addr->flags;
 102         uchar flag2 = flash_addr_new->flags;
 103
 104         ulong addr_default = (ulong)&default_environment[0];
 105         ulong addr1 = (ulong)&(flash_addr->data);
 106         ulong addr2 = (ulong)&(flash_addr_new->data);
 107
 108         crc1_ok = (crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc);
 109         crc2_ok = (crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc);
 110
 111         if(crc1_ok && !crc2_ok){
 112                 gd->env_addr  = addr1;
 113                 gd->env_valid = 1;
 114         } else if(!crc1_ok && crc2_ok){
 115                 gd->env_addr  = addr2;
 116                 gd->env_valid = 1;
 117         } else if(!crc1_ok && !crc2_ok){
 118                 gd->env_addr  = addr_default;
 119                 gd->env_valid = 0;
 120         } else if(flag1 == ACTIVE_FLAG && flag2 == OBSOLETE_FLAG){
 121                 gd->env_addr  = addr1;
 122                 gd->env_valid = 1;
 123         } else if(flag1 == OBSOLETE_FLAG && flag2 == ACTIVE_FLAG){
 124                 gd->env_addr  = addr2;
 125                 gd->env_valid = 1;
 126         } else if(flag1 == flag2){
 127                 gd->env_addr  = addr1;
 128                 gd->env_valid = 2;
 129         } else if(flag1 == 0xFF){
 130                 gd->env_addr  = addr1;
 131                 gd->env_valid = 2;
 132         } else if(flag2 == 0xFF){
 133                 gd->env_addr  = addr2;
 134                 gd->env_valid = 2;
 135         }
 136
 137         return(0);
 138 }
 139
 140 #ifdef CMD_SAVEENV
 141 int saveenv(void){
 142         char *saved_data = NULL;
 143         int rc = 1;
 144         char flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
 145 #if CFG_ENV_SECT_SIZE > CFG_ENV_SIZE
 146         ulong up_data = 0;
 147 #endif
 148
 149         //debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
 150
 151         if(flash_sect_protect(0, (ulong)flash_addr, end_addr)){
 152                 goto Done;
 153         }
 154
 155         //debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr_new, end_addr_new);
 156
 157         if(flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new)){
 158                 goto Done;
 159         }
 160
 161 #if CFG_ENV_SECT_SIZE > CFG_ENV_SIZE
 162         up_data = (end_addr_new + 1 - ((long)flash_addr_new + CFG_ENV_SIZE));
 163         //debug ("Data to save 0x%x\n", up_data);
 164
 165         if(up_data){
 166                 if((saved_data = malloc(up_data)) == NULL){
 167                         printf("## Error: unable to save the rest of sector (%ld)\n", up_data);
 168                         goto Done;
 169                 }
 170
 171                 memcpy(saved_data, (void *)((long)flash_addr_new + CFG_ENV_SIZE), up_data);
 172                 //debug("Data (start 0x%x, len 0x%x) saved at 0x%x\n", (long)flash_addr_new + CFG_ENV_SIZE, up_data, saved_data);
 173         }
 174 #endif
 175         //debug("Erasing Flash...");
 176         //debug(" %08lX ... %08lX ...", (ulong)flash_addr_new, end_addr_new);
 177
 178         if(flash_sect_erase((ulong)flash_addr_new, end_addr_new)){
 179                 goto Done;
 180         }
 181
 182         //debug("Writing to Flash... ");
 183         //debug(" %08lX ... %08lX ...", (ulong)&(flash_addr_new->data), sizeof(env_ptr->data)+(ulong)&(flash_addr_new->data));
 184
 185         if((rc = flash_write((char *)env_ptr->data, (ulong)&(flash_addr_new->data), sizeof(env_ptr->data))) ||
 186            (rc = flash_write((char *)&(env_ptr->crc), (ulong)&(flash_addr_new->crc), sizeof(env_ptr->crc))) ||
 187            (rc = flash_write(&flag, (ulong)&(flash_addr->flags), sizeof(flash_addr->flags))) ||
 188            (rc = flash_write(&new_flag, (ulong)&(flash_addr_new->flags), sizeof(flash_addr_new->flags)))){
 189                 flash_perror(rc);
 190                 goto Done;
 191         }
 192
 193         //debug("done\n");
 194
 195 #if CFG_ENV_SECT_SIZE > CFG_ENV_SIZE
 196         if(up_data){ /* restore the rest of sector */
 197                 //debug("Restoring the rest of data to 0x%x len 0x%x\n", (long)flash_addr_new + CFG_ENV_SIZE, up_data);
 198                 if(flash_write(saved_data, (long)flash_addr_new + CFG_ENV_SIZE, up_data)){
 199                         flash_perror(rc);
 200                         goto Done;
 201                 }
 202         }
 203 #endif
 204         env_t * etmp = flash_addr;
 205         ulong ltmp = end_addr;
 206
 207         flash_addr = flash_addr_new;
 208         flash_addr_new = etmp;
 209
 210         end_addr = end_addr_new;
 211         end_addr_new = ltmp;
 212
 213         rc = 0;
 214
 215 Done:
 216
 217         if(saved_data){
 218                 free(saved_data);
 219         }
 220
 221         /* try to re-protect */
 222         (void)flash_sect_protect(1, (ulong)flash_addr, end_addr);
 223         (void)flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
 224
 225         return(rc);
 226 }
 227 #endif /* CMD_SAVEENV */
 228
 229 #else /* ! CFG_ENV_ADDR_REDUND */
 230 int env_init(void){
 231         if(crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc){
 232                 gd->env_addr = (ulong)&(env_ptr->data);
 233                 gd->env_valid = 1;
 234
 235                 return(0);
 236         }
 237
 238         gd->env_addr = (ulong)&default_environment[0];
 239         gd->env_valid = 0;
 240
 241         return(0);
 242 }
 243
 244 #ifdef CMD_SAVEENV
 245 int saveenv(void){
 246         int     len, rc;
 247         ulong end_addr, flash_sect_addr;
 248 #if defined(CFG_ENV_SECT_SIZE) && (CFG_ENV_SECT_SIZE > CFG_ENV_SIZE)
 249         ulong flash_offset;
 250         uchar env_buffer[CFG_ENV_SECT_SIZE];
 251 #else
 252         uchar *env_buffer = (uchar *)env_ptr;
 253 #endif /* CFG_ENV_SECT_SIZE */
 254         int rcode = 0;
 255
 256 #if defined(CFG_ENV_SECT_SIZE) && (CFG_ENV_SECT_SIZE > CFG_ENV_SIZE)
 257
 258         flash_offset    = ((ulong)flash_addr) & (CFG_ENV_SECT_SIZE-1);
 259         flash_sect_addr = ((ulong)flash_addr) & ~(CFG_ENV_SECT_SIZE-1);
 260
 261         //debug("copy old content: sect_addr: %08lX  env_addr: %08lX  offset: %08lX\n", flash_sect_addr, (ulong)flash_addr, flash_offset);
 262
 263         /* copy old contents to temporary buffer */
 264         memcpy(env_buffer, (void *)flash_sect_addr, CFG_ENV_SECT_SIZE);
 265
 266         /* copy current environment to temporary buffer */
 267         memcpy((uchar *)((unsigned long)env_buffer + flash_offset), env_ptr, CFG_ENV_SIZE);
 268
 269         len      = CFG_ENV_SECT_SIZE;
 270 #else
 271         flash_sect_addr = (ulong)flash_addr;
 272         len = CFG_ENV_SIZE;
 273 #endif  /* CFG_ENV_SECT_SIZE */
 274
 275 #ifndef CONFIG_INFERNO
 276         end_addr = flash_sect_addr + len - 1;
 277 #else
 278         /* this is the last sector, and the size is hardcoded here */
 279         /* otherwise we will get stack problems on loading 128 KB environment */
 280         end_addr = flash_sect_addr + 0x20000 - 1;
 281 #endif
 282
 283         //debug("Protect off %08lX ... %08lX\n", (ulong)flash_sect_addr, end_addr);
 284
 285         if(flash_sect_protect(0, flash_sect_addr, end_addr)){
 286                 return(1);
 287         }
 288
 289         //debug("Erasing Flash...");
 290
 291         if(flash_sect_erase(flash_sect_addr, end_addr)){
 292                 return(1);
 293         }
 294
 295         //debug("Writing to Flash... ");
 296
 297         rc = flash_write((char *)env_buffer, flash_sect_addr, len);
 298
 299         if(rc != 0){
 300                 flash_perror(rc);
 301                 rcode = 1;
 302         } else {
 303                 //debug("done\n");
 304         }
 305
 306         /* try to re-protect */
 307         (void)flash_sect_protect(1, flash_sect_addr, end_addr);
 308
 309         return(rcode);
 310 }
 311
 312 #endif /* CMD_SAVEENV */
 313
 314 #endif /* CFG_ENV_ADDR_REDUND */
 315
 316 void env_relocate_spec(void){
 317 #if !defined(ENV_IS_EMBEDDED) || defined(CFG_ENV_ADDR_REDUND)
 318         #ifdef CFG_ENV_ADDR_REDUND
 319         if(gd->env_addr != (ulong)&(flash_addr->data)){
 320                 env_t * etmp = flash_addr;
 321                 ulong ltmp = end_addr;
 322
 323                 flash_addr = flash_addr_new;
 324                 flash_addr_new = etmp;
 325
 326                 end_addr = end_addr_new;
 327                 end_addr_new = ltmp;
 328         }
 329
 330         if(flash_addr_new->flags != OBSOLETE_FLAG && crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc){
 331                 char flag = OBSOLETE_FLAG;
 332
 333                 gd->env_valid = 2;
 334
 335                 flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new);
 336                 flash_write(&flag, (ulong)&(flash_addr_new->flags), sizeof(flash_addr_new->flags));
 337                 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
 338         }
 339
 340         if(flash_addr->flags != ACTIVE_FLAG && (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG){
 341                 char flag = ACTIVE_FLAG;
 342
 343                 gd->env_valid = 2;
 344
 345                 flash_sect_protect(0, (ulong)flash_addr, end_addr);
 346                 flash_write(&flag, (ulong)&(flash_addr->flags), sizeof(flash_addr->flags));
 347                 flash_sect_protect(1, (ulong)flash_addr, end_addr);
 348         }
 349
 350         if(gd->env_valid == 2){
 351                 puts("** Warning: some problems detected reading environment, recovered successfully\n");
 352         }
 353         #endif /* CFG_ENV_ADDR_REDUND */
 354
 355         memcpy(env_ptr, (void*)flash_addr, CFG_ENV_SIZE);
 356
 357 #endif /* ! ENV_IS_EMBEDDED || CFG_ENV_ADDR_REDUND */
 358 }
 359
 360 #endif /* CFG_ENV_IS_IN_FLASH */