common/env_flash.c

   1 /*
   2  * (C) Copyright 2000-2010
   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 #include <search.h>
  35 #include <errno.h>
  36
  37 DECLARE_GLOBAL_DATA_PTR;
  38
  39 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_FLASH)
  40 #define CMD_SAVEENV
  41 #elif defined(CONFIG_ENV_ADDR_REDUND)
  42 #error Cannot use CONFIG_ENV_ADDR_REDUND without CONFIG_CMD_SAVEENV & CONFIG_CMD_FLASH
  43 #endif
  44
  45 #if defined(CONFIG_ENV_SIZE_REDUND) && (CONFIG_ENV_SIZE_REDUND < CONFIG_ENV_SIZE)
  46 #error CONFIG_ENV_SIZE_REDUND should not be less then CONFIG_ENV_SIZE
  47 #endif
  48
  49 char * env_name_spec = "Flash";
  50
  51 #ifdef ENV_IS_EMBEDDED
  52
  53 extern uchar environment[];
  54 env_t *env_ptr = (env_t *)(&environment[0]);
  55
  56 static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
  57
  58 #else /* ! ENV_IS_EMBEDDED */
  59
  60 env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
  61 static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
  62
  63 #endif /* ENV_IS_EMBEDDED */
  64
  65 #if defined(CMD_SAVEENV) || defined(CONFIG_ENV_ADDR_REDUND)
  66 /* CONFIG_ENV_ADDR is supposed to be on sector boundary */
  67 static ulong end_addr = CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1;
  68 #endif
  69
  70 #ifdef CONFIG_ENV_ADDR_REDUND
  71 static env_t *flash_addr_new = (env_t *)CONFIG_ENV_ADDR_REDUND;
  72
  73 /* CONFIG_ENV_ADDR_REDUND is supposed to be on sector boundary */
  74 static ulong end_addr_new = CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1;
  75 #endif /* CONFIG_ENV_ADDR_REDUND */
  76
  77
  78 uchar env_get_char_spec(int index)
  79 {
  80         return (*((uchar *)(gd->env_addr + index)));
  81 }
  82
  83 #ifdef CONFIG_ENV_ADDR_REDUND
  84
  85 int  env_init(void)
  86 {
  87         int crc1_ok = 0, crc2_ok = 0;
  88
  89         uchar flag1 = flash_addr->flags;
  90         uchar flag2 = flash_addr_new->flags;
  91
  92         ulong addr_default = (ulong)&default_environment[0];
  93         ulong addr1 = (ulong)&(flash_addr->data);
  94         ulong addr2 = (ulong)&(flash_addr_new->data);
  95
  96         crc1_ok = (crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc);
  97         crc2_ok = (crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc);
  98
  99         if (crc1_ok && ! crc2_ok) {
 100                 gd->env_addr  = addr1;
 101                 gd->env_valid = 1;
 102         } else if (! crc1_ok && crc2_ok) {
 103                 gd->env_addr  = addr2;
 104                 gd->env_valid = 1;
 105         } else if (! crc1_ok && ! crc2_ok) {
 106                 gd->env_addr  = addr_default;
 107                 gd->env_valid = 0;
 108         } else if (flag1 == ACTIVE_FLAG && flag2 == OBSOLETE_FLAG) {
 109                 gd->env_addr  = addr1;
 110                 gd->env_valid = 1;
 111         } else if (flag1 == OBSOLETE_FLAG && flag2 == ACTIVE_FLAG) {
 112                 gd->env_addr  = addr2;
 113                 gd->env_valid = 1;
 114         } else if (flag1 == flag2) {
 115                 gd->env_addr  = addr1;
 116                 gd->env_valid = 2;
 117         } else if (flag1 == 0xFF) {
 118                 gd->env_addr  = addr1;
 119                 gd->env_valid = 2;
 120         } else if (flag2 == 0xFF) {
 121                 gd->env_addr  = addr2;
 122                 gd->env_valid = 2;
 123         }
 124
 125         return 0;
 126 }
 127
 128 #ifdef CMD_SAVEENV
 129 int saveenv(void)
 130 {
 131         env_t   env_new;
 132         ssize_t len;
 133         char    *saved_data = NULL;
 134         char    *res;
 135         int     rc = 1;
 136         char    flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
 137 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 138         ulong   up_data = 0;
 139 #endif
 140
 141         debug("Protect off %08lX ... %08lX\n",
 142                 (ulong)flash_addr, end_addr);
 143
 144         if (flash_sect_protect(0, (ulong)flash_addr, end_addr)) {
 145                 goto done;
 146         }
 147
 148         debug("Protect off %08lX ... %08lX\n",
 149                 (ulong)flash_addr_new, end_addr_new);
 150
 151         if (flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new)) {
 152                 goto done;
 153         }
 154
 155         res = (char *)&env_new.data;
 156         len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
 157         if (len < 0) {
 158                 error("Cannot export environment: errno = %d\n", errno);
 159                 goto done;
 160         }
 161         env_new.crc   = crc32(0, env_new.data, ENV_SIZE);
 162         env_new.flags = new_flag;
 163
 164 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 165         up_data = (end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE));
 166         debug("Data to save 0x%lX\n", up_data);
 167         if (up_data) {
 168                 if ((saved_data = malloc(up_data)) == NULL) {
 169                         printf("Unable to save the rest of sector (%ld)\n",
 170                                 up_data);
 171                         goto done;
 172                 }
 173                 memcpy(saved_data,
 174                         (void *)((long)flash_addr_new + CONFIG_ENV_SIZE), up_data);
 175                 debug("Data (start 0x%lX, len 0x%lX) saved at 0x%p\n",
 176                         (long)flash_addr_new + CONFIG_ENV_SIZE,
 177                         up_data, saved_data);
 178         }
 179 #endif
 180         puts("Erasing Flash...");
 181         debug(" %08lX ... %08lX ...",
 182                 (ulong)flash_addr_new, end_addr_new);
 183
 184         if (flash_sect_erase((ulong)flash_addr_new, end_addr_new)) {
 185                 goto done;
 186         }
 187
 188         puts("Writing to Flash... ");
 189         debug(" %08lX ... %08lX ...",
 190                 (ulong)&(flash_addr_new->data),
 191                 sizeof(env_ptr->data)+(ulong)&(flash_addr_new->data));
 192         if ((rc = flash_write((char *)&env_new,
 193                         (ulong)flash_addr_new,
 194                         sizeof(env_new))) ||
 195             (rc = flash_write(&flag,
 196                         (ulong)&(flash_addr->flags),
 197                         sizeof(flash_addr->flags))) ) {
 198                 flash_perror(rc);
 199                 goto done;
 200         }
 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%lX len 0x%lX\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         puts("done\n");
 215
 216         {
 217                 env_t * etmp = flash_addr;
 218                 ulong ltmp = end_addr;
 219
 220                 flash_addr = flash_addr_new;
 221                 flash_addr_new = etmp;
 222
 223                 end_addr = end_addr_new;
 224                 end_addr_new = ltmp;
 225         }
 226
 227         rc = 0;
 228 done:
 229         if (saved_data)
 230                 free(saved_data);
 231         /* try to re-protect */
 232         (void) flash_sect_protect(1, (ulong)flash_addr, end_addr);
 233         (void) flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
 234
 235         return rc;
 236 }
 237 #endif /* CMD_SAVEENV */
 238
 239 #else /* ! CONFIG_ENV_ADDR_REDUND */
 240
 241 int  env_init(void)
 242 {
 243         if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
 244                 gd->env_addr  = (ulong)&(env_ptr->data);
 245                 gd->env_valid = 1;
 246                 return(0);
 247         }
 248
 249         gd->env_addr  = (ulong)&default_environment[0];
 250         gd->env_valid = 0;
 251         return 0;
 252 }
 253
 254 #ifdef CMD_SAVEENV
 255
 256 int saveenv(void)
 257 {
 258         env_t   env_new;
 259         ssize_t len;
 260         int     rc = 1;
 261         char    *res;
 262         char    *saved_data = NULL;
 263 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 264         ulong   up_data = 0;
 265
 266         up_data = (end_addr + 1 - ((long)flash_addr + CONFIG_ENV_SIZE));
 267         debug("Data to save 0x%lx\n", up_data);
 268         if (up_data) {
 269                 if ((saved_data = malloc(up_data)) == NULL) {
 270                         printf("Unable to save the rest of sector (%ld)\n",
 271                                 up_data);
 272                         goto done;
 273                 }
 274                 memcpy(saved_data,
 275                         (void *)((long)flash_addr + CONFIG_ENV_SIZE), up_data);
 276                 debug("Data (start 0x%lx, len 0x%lx) saved at 0x%lx\n",
 277                         (ulong)flash_addr + CONFIG_ENV_SIZE,
 278                         up_data,
 279                         (ulong)saved_data);
 280         }
 281 #endif  /* CONFIG_ENV_SECT_SIZE */
 282
 283         debug("Protect off %08lX ... %08lX\n",
 284                 (ulong)flash_addr, end_addr);
 285
 286         if (flash_sect_protect(0, (long)flash_addr, end_addr))
 287                 goto done;
 288
 289         res = (char *)&env_new.data;
 290         len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
 291         if (len < 0) {
 292                 error("Cannot export environment: errno = %d\n", errno);
 293                 goto done;
 294         }
 295         env_new.crc = crc32(0, env_new.data, ENV_SIZE);
 296
 297         puts("Erasing Flash...");
 298         if (flash_sect_erase((long)flash_addr, end_addr))
 299                 goto done;
 300
 301         puts("Writing to Flash... ");
 302         rc = flash_write((char *)&env_new, (long)flash_addr, CONFIG_ENV_SIZE);
 303         if (rc != 0) {
 304                 flash_perror(rc);
 305                 goto done;
 306         }
 307 #if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 308         if (up_data) {  /* restore the rest of sector */
 309                 debug("Restoring the rest of data to 0x%lx len 0x%lx\n",
 310                         (ulong)flash_addr + CONFIG_ENV_SIZE, up_data);
 311                 if (flash_write(saved_data,
 312                                 (long)flash_addr + CONFIG_ENV_SIZE,
 313                                 up_data)) {
 314                         flash_perror(rc);
 315                         goto done;
 316                 }
 317         }
 318 #endif
 319         puts("done\n");
 320         rc = 0;
 321 done:
 322         if (saved_data)
 323                 free(saved_data);
 324         /* try to re-protect */
 325         (void) flash_sect_protect(1, (long)flash_addr, end_addr);
 326         return rc;
 327 }
 328
 329 #endif /* CMD_SAVEENV */
 330
 331 #endif /* CONFIG_ENV_ADDR_REDUND */
 332
 333 void env_relocate_spec(void)
 334 {
 335 #ifdef CONFIG_ENV_ADDR_REDUND
 336         if (gd->env_addr != (ulong)&(flash_addr->data)) {
 337                 env_t *etmp = flash_addr;
 338                 ulong ltmp = end_addr;
 339
 340                 flash_addr = flash_addr_new;
 341                 flash_addr_new = etmp;
 342
 343                 end_addr = end_addr_new;
 344                 end_addr_new = ltmp;
 345         }
 346
 347         if (flash_addr_new->flags != OBSOLETE_FLAG &&
 348             crc32(0, flash_addr_new->data, ENV_SIZE) ==
 349             flash_addr_new->crc) {
 350                 char flag = OBSOLETE_FLAG;
 351
 352                 gd->env_valid = 2;
 353                 flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new);
 354                 flash_write(&flag,
 355                             (ulong)&(flash_addr_new->flags),
 356                             sizeof(flash_addr_new->flags));
 357                 flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
 358         }
 359
 360         if (flash_addr->flags != ACTIVE_FLAG &&
 361             (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG) {
 362                 char flag = ACTIVE_FLAG;
 363
 364                 gd->env_valid = 2;
 365                 flash_sect_protect(0, (ulong)flash_addr, end_addr);
 366                 flash_write(&flag,
 367                             (ulong)&(flash_addr->flags),
 368                             sizeof(flash_addr->flags));
 369                 flash_sect_protect(1, (ulong)flash_addr, end_addr);
 370         }
 371
 372         if (gd->env_valid == 2)
 373                 puts ("*** Warning - some problems detected "
 374                       "reading environment; recovered successfully\n\n");
 375 #endif /* CONFIG_ENV_ADDR_REDUND */
 376
 377         env_import((char *)flash_addr, 1);
 378 }