common/env_sf.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  * (C) Copyright 2008 Atmel Corporation
   9  *
  10  * See file CREDITS for list of people who contributed to this
  11  * project.
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License as
  15  * published by the Free Software Foundation; either version 2 of
  16  * the License, or (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  26  * MA 02111-1307 USA
  27  */
  28 #include <common.h>
  29 #include <environment.h>
  30 #include <malloc.h>
  31 #include <spi_flash.h>
  32 #include <search.h>
  33 #include <errno.h>
  34
  35 #ifndef CONFIG_ENV_SPI_BUS
  36 # define CONFIG_ENV_SPI_BUS     0
  37 #endif
  38 #ifndef CONFIG_ENV_SPI_CS
  39 # define CONFIG_ENV_SPI_CS      0
  40 #endif
  41 #ifndef CONFIG_ENV_SPI_MAX_HZ
  42 # define CONFIG_ENV_SPI_MAX_HZ  1000000
  43 #endif
  44 #ifndef CONFIG_ENV_SPI_MODE
  45 # define CONFIG_ENV_SPI_MODE    SPI_MODE_3
  46 #endif
  47
  48 #ifdef CONFIG_ENV_OFFSET_REDUND
  49 static ulong env_offset         = CONFIG_ENV_OFFSET;
  50 static ulong env_new_offset     = CONFIG_ENV_OFFSET_REDUND;
  51
  52 #define ACTIVE_FLAG     1
  53 #define OBSOLETE_FLAG   0
  54 #endif /* CONFIG_ENV_OFFSET_REDUND */
  55
  56 DECLARE_GLOBAL_DATA_PTR;
  57
  58 char *env_name_spec = "SPI Flash";
  59
  60 static struct spi_flash *env_flash;
  61
  62 uchar env_get_char_spec(int index)
  63 {
  64         return *((uchar *)(gd->env_addr + index));
  65 }
  66
  67 #if defined(CONFIG_ENV_OFFSET_REDUND)
  68 int saveenv(void)
  69 {
  70         env_t   env_new;
  71         ssize_t len;
  72         char    *res, *saved_buffer = NULL, flag = OBSOLETE_FLAG;
  73         u32     saved_size, saved_offset, sector = 1;
  74         int     ret;
  75
  76         if (!env_flash) {
  77                 env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
  78                         CONFIG_ENV_SPI_CS,
  79                         CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
  80                 if (!env_flash) {
  81                         set_default_env("!spi_flash_probe() failed");
  82                         return 1;
  83                 }
  84         }
  85
  86         res = (char *)&env_new.data;
  87         len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
  88         if (len < 0) {
  89                 error("Cannot export environment: errno = %d\n", errno);
  90                 return 1;
  91         }
  92         env_new.crc     = crc32(0, env_new.data, ENV_SIZE);
  93         env_new.flags   = ACTIVE_FLAG;
  94
  95         if (gd->env_valid == 1) {
  96                 env_new_offset = CONFIG_ENV_OFFSET_REDUND;
  97                 env_offset = CONFIG_ENV_OFFSET;
  98         } else {
  99                 env_new_offset = CONFIG_ENV_OFFSET;
 100                 env_offset = CONFIG_ENV_OFFSET_REDUND;
 101         }
 102
 103         /* Is the sector larger than the env (i.e. embedded) */
 104         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 105                 saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
 106                 saved_offset = env_new_offset + CONFIG_ENV_SIZE;
 107                 saved_buffer = malloc(saved_size);
 108                 if (!saved_buffer) {
 109                         ret = 1;
 110                         goto done;
 111                 }
 112                 ret = spi_flash_read(env_flash, saved_offset,
 113                                         saved_size, saved_buffer);
 114                 if (ret)
 115                         goto done;
 116         }
 117
 118         if (CONFIG_ENV_SIZE > CONFIG_ENV_SECT_SIZE) {
 119                 sector = CONFIG_ENV_SIZE / CONFIG_ENV_SECT_SIZE;
 120                 if (CONFIG_ENV_SIZE % CONFIG_ENV_SECT_SIZE)
 121                         sector++;
 122         }
 123
 124         puts("Erasing SPI flash...");
 125         ret = spi_flash_erase(env_flash, env_new_offset,
 126                                 sector * CONFIG_ENV_SECT_SIZE);
 127         if (ret)
 128                 goto done;
 129
 130         puts("Writing to SPI flash...");
 131
 132         ret = spi_flash_write(env_flash, env_new_offset,
 133                 CONFIG_ENV_SIZE, &env_new);
 134         if (ret)
 135                 goto done;
 136
 137         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 138                 ret = spi_flash_write(env_flash, saved_offset,
 139                                         saved_size, saved_buffer);
 140                 if (ret)
 141                         goto done;
 142         }
 143
 144         ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
 145                                 sizeof(env_new.flags), &flag);
 146         if (ret)
 147                 goto done;
 148
 149         puts("done\n");
 150
 151         gd->env_valid = gd->env_valid == 2 ? 1 : 2;
 152
 153         printf("Valid environment: %d\n", (int)gd->env_valid);
 154
 155  done:
 156         if (saved_buffer)
 157                 free(saved_buffer);
 158
 159         return ret;
 160 }
 161
 162 void env_relocate_spec(void)
 163 {
 164         int ret;
 165         int crc1_ok = 0, crc2_ok = 0;
 166         env_t *tmp_env1 = NULL;
 167         env_t *tmp_env2 = NULL;
 168         env_t *ep = NULL;
 169
 170         tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
 171         tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
 172
 173         if (!tmp_env1 || !tmp_env2) {
 174                 set_default_env("!malloc() failed");
 175                 goto out;
 176         }
 177
 178         env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
 179                         CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
 180         if (!env_flash) {
 181                 set_default_env("!spi_flash_probe() failed");
 182                 goto out;
 183         }
 184
 185         ret = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
 186                                 CONFIG_ENV_SIZE, tmp_env1);
 187         if (ret) {
 188                 set_default_env("!spi_flash_read() failed");
 189                 goto err_read;
 190         }
 191
 192         if (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc)
 193                 crc1_ok = 1;
 194
 195         ret = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
 196                                 CONFIG_ENV_SIZE, tmp_env2);
 197         if (!ret) {
 198                 if (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc)
 199                         crc2_ok = 1;
 200         }
 201
 202         if (!crc1_ok && !crc2_ok) {
 203                 set_default_env("!bad CRC");
 204                 goto err_read;
 205         } else if (crc1_ok && !crc2_ok) {
 206                 gd->env_valid = 1;
 207         } else if (!crc1_ok && crc2_ok) {
 208                 gd->env_valid = 2;
 209         } else if (tmp_env1->flags == ACTIVE_FLAG &&
 210                    tmp_env2->flags == OBSOLETE_FLAG) {
 211                 gd->env_valid = 1;
 212         } else if (tmp_env1->flags == OBSOLETE_FLAG &&
 213                    tmp_env2->flags == ACTIVE_FLAG) {
 214                 gd->env_valid = 2;
 215         } else if (tmp_env1->flags == tmp_env2->flags) {
 216                 gd->env_valid = 2;
 217         } else if (tmp_env1->flags == 0xFF) {
 218                 gd->env_valid = 2;
 219         } else {
 220                 /*
 221                  * this differs from code in env_flash.c, but I think a sane
 222                  * default path is desirable.
 223                  */
 224                 gd->env_valid = 2;
 225         }
 226
 227         if (gd->env_valid == 1)
 228                 ep = tmp_env1;
 229         else
 230                 ep = tmp_env2;
 231
 232         ret = env_import((char *)ep, 0);
 233         if (!ret) {
 234                 error("Cannot import environment: errno = %d\n", errno);
 235                 set_default_env("env_import failed");
 236         }
 237
 238 err_read:
 239         spi_flash_free(env_flash);
 240         env_flash = NULL;
 241 out:
 242         free(tmp_env1);
 243         free(tmp_env2);
 244 }
 245 #else
 246 int saveenv(void)
 247 {
 248         u32     saved_size, saved_offset, sector = 1;
 249         char    *res, *saved_buffer = NULL;
 250         int     ret = 1;
 251         env_t   env_new;
 252         ssize_t len;
 253
 254         if (!env_flash) {
 255                 env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
 256                         CONFIG_ENV_SPI_CS,
 257                         CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
 258                 if (!env_flash) {
 259                         set_default_env("!spi_flash_probe() failed");
 260                         return 1;
 261                 }
 262         }
 263
 264         /* Is the sector larger than the env (i.e. embedded) */
 265         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 266                 saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
 267                 saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
 268                 saved_buffer = malloc(saved_size);
 269                 if (!saved_buffer)
 270                         goto done;
 271
 272                 ret = spi_flash_read(env_flash, saved_offset,
 273                         saved_size, saved_buffer);
 274                 if (ret)
 275                         goto done;
 276         }
 277
 278         if (CONFIG_ENV_SIZE > CONFIG_ENV_SECT_SIZE) {
 279                 sector = CONFIG_ENV_SIZE / CONFIG_ENV_SECT_SIZE;
 280                 if (CONFIG_ENV_SIZE % CONFIG_ENV_SECT_SIZE)
 281                         sector++;
 282         }
 283
 284         res = (char *)&env_new.data;
 285         len = hexport_r(&env_htab, '\0', &res, ENV_SIZE, 0, NULL);
 286         if (len < 0) {
 287                 error("Cannot export environment: errno = %d\n", errno);
 288                 goto done;
 289         }
 290         env_new.crc = crc32(0, env_new.data, ENV_SIZE);
 291
 292         puts("Erasing SPI flash...");
 293         ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
 294                 sector * CONFIG_ENV_SECT_SIZE);
 295         if (ret)
 296                 goto done;
 297
 298         puts("Writing to SPI flash...");
 299         ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
 300                 CONFIG_ENV_SIZE, &env_new);
 301         if (ret)
 302                 goto done;
 303
 304         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 305                 ret = spi_flash_write(env_flash, saved_offset,
 306                         saved_size, saved_buffer);
 307                 if (ret)
 308                         goto done;
 309         }
 310
 311         ret = 0;
 312         puts("done\n");
 313
 314  done:
 315         if (saved_buffer)
 316                 free(saved_buffer);
 317
 318         return ret;
 319 }
 320
 321 void env_relocate_spec(void)
 322 {
 323         char buf[CONFIG_ENV_SIZE];
 324         int ret;
 325
 326         env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
 327                         CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
 328         if (!env_flash) {
 329                 set_default_env("!spi_flash_probe() failed");
 330                 return;
 331         }
 332
 333         ret = spi_flash_read(env_flash,
 334                 CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
 335         if (ret) {
 336                 set_default_env("!spi_flash_read() failed");
 337                 goto out;
 338         }
 339
 340         ret = env_import(buf, 1);
 341         if (ret)
 342                 gd->env_valid = 1;
 343 out:
 344         spi_flash_free(env_flash);
 345         env_flash = NULL;
 346 }
 347 #endif
 348
 349 int env_init(void)
 350 {
 351         /* SPI flash isn't usable before relocation */
 352         gd->env_addr = (ulong)&default_environment[0];
 353         gd->env_valid = 1;
 354
 355         return 0;
 356 }