common/env_sf.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  * (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
  30 #ifdef CFG_ENV_IS_IN_SPI_FLASH
  31
  32 #include <environment.h>
  33 #include <spi_flash.h>
  34
  35 #ifndef CFG_ENV_SPI_BUS
  36 # define CFG_ENV_SPI_BUS        0
  37 #endif
  38 #ifndef CFG_ENV_SPI_CS
  39 # define CFG_ENV_SPI_CS         0
  40 #endif
  41 #ifndef CFG_ENV_SPI_MAX_HZ
  42 # define CFG_ENV_SPI_MAX_HZ     1000000
  43 #endif
  44 #ifndef CFG_ENV_SPI_MODE
  45 # define CFG_ENV_SPI_MODE       SPI_MODE_3
  46 #endif
  47
  48 DECLARE_GLOBAL_DATA_PTR;
  49
  50 /* references to names in env_common.c */
  51 extern uchar default_environment[];
  52 extern int default_environment_size;
  53
  54 char * env_name_spec = "SPI Flash";
  55 env_t *env_ptr;
  56
  57 static struct spi_flash *env_flash;
  58
  59 uchar env_get_char_spec(int index)
  60 {
  61         return *((uchar *)(gd->env_addr + index));
  62 }
  63
  64 int saveenv(void)
  65 {
  66         if (!env_flash) {
  67                 puts("Environment SPI flash not initialized\n");
  68                 return 1;
  69         }
  70
  71         puts("Erasing SPI flash...");
  72         if (spi_flash_erase(env_flash, CFG_ENV_OFFSET, CFG_ENV_SIZE))
  73                 return 1;
  74
  75         puts("Writing to SPI flash...");
  76         if (spi_flash_write(env_flash, CFG_ENV_OFFSET, CFG_ENV_SIZE, env_ptr))
  77                 return 1;
  78
  79         puts("done\n");
  80         return 0;
  81 }
  82
  83 void env_relocate_spec(void)
  84 {
  85         int ret;
  86
  87         env_flash = spi_flash_probe(CFG_ENV_SPI_BUS, CFG_ENV_SPI_CS,
  88                         CFG_ENV_SPI_MAX_HZ, CFG_ENV_SPI_MODE);
  89         if (!env_flash)
  90                 goto err_probe;
  91
  92         ret = spi_flash_read(env_flash, CFG_ENV_OFFSET, CFG_ENV_SIZE, env_ptr);
  93         if (ret)
  94                 goto err_read;
  95
  96         if (crc32(0, env_ptr->data, ENV_SIZE) != env_ptr->crc)
  97                 goto err_crc;
  98
  99         gd->env_valid = 1;
 100
 101         return;
 102
 103 err_read:
 104         spi_flash_free(env_flash);
 105         env_flash = NULL;
 106 err_probe:
 107 err_crc:
 108         puts("*** Warning - bad CRC, using default environment\n\n");
 109
 110         if (default_environment_size > CFG_ENV_SIZE) {
 111                 gd->env_valid = 0;
 112                 puts("*** Error - default environment is too large\n\n");
 113                 return;
 114         }
 115
 116         memset(env_ptr, 0, sizeof(env_t));
 117         memcpy(env_ptr->data, default_environment, default_environment_size);
 118         env_ptr->crc = crc32(0, env_ptr->data, ENV_SIZE);
 119         gd->env_valid = 1;
 120 }
 121
 122 int env_init(void)
 123 {
 124         /* SPI flash isn't usable before relocation */
 125         gd->env_addr = (ulong)&default_environment[0];
 126         gd->env_valid = 1;
 127
 128         return 0;
 129 }
 130
 131 #endif /* CFG_ENV_IS_IN_SPI_FLASH */