env/sf.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000-2010
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  *
   6  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   7  * Andreas Heppel <aheppel@sysgo.de>
   8  *
   9  * (C) Copyright 2008 Atmel Corporation
  10  */
  11 #include <common.h>
  12 #include <dm.h>
  13 #include <env.h>
  14 #include <environment.h>
  15 #include <malloc.h>
  16 #include <spi.h>
  17 #include <spi_flash.h>
  18 #include <search.h>
  19 #include <errno.h>
  20 #include <dm/device-internal.h>
  21
  22 #ifndef CONFIG_SPL_BUILD
  23 #define CMD_SAVEENV
  24 #define INITENV
  25 #endif
  26
  27 #ifdef CONFIG_ENV_OFFSET_REDUND
  28 #ifdef CMD_SAVEENV
  29 static ulong env_offset         = CONFIG_ENV_OFFSET;
  30 static ulong env_new_offset     = CONFIG_ENV_OFFSET_REDUND;
  31 #endif
  32
  33 #define ACTIVE_FLAG     1
  34 #define OBSOLETE_FLAG   0
  35 #endif /* CONFIG_ENV_OFFSET_REDUND */
  36
  37 DECLARE_GLOBAL_DATA_PTR;
  38
  39 static struct spi_flash *env_flash;
  40
  41 static int setup_flash_device(void)
  42 {
  43 #ifdef CONFIG_DM_SPI_FLASH
  44         struct udevice *new;
  45         int     ret;
  46
  47         /* speed and mode will be read from DT */
  48         ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
  49                                      CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
  50                                      &new);
  51         if (ret) {
  52                 env_set_default("spi_flash_probe_bus_cs() failed", 0);
  53                 return ret;
  54         }
  55
  56         env_flash = dev_get_uclass_priv(new);
  57 #else
  58
  59         if (!env_flash) {
  60                 env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS,
  61                         CONFIG_ENV_SPI_CS,
  62                         CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
  63                 if (!env_flash) {
  64                         env_set_default("spi_flash_probe() failed", 0);
  65                         return -EIO;
  66                 }
  67         }
  68 #endif
  69         return 0;
  70 }
  71
  72 #if defined(CONFIG_ENV_OFFSET_REDUND)
  73 #ifdef CMD_SAVEENV
  74 static int env_sf_save(void)
  75 {
  76         env_t   env_new;
  77         char    *saved_buffer = NULL, flag = OBSOLETE_FLAG;
  78         u32     saved_size, saved_offset, sector;
  79         int     ret;
  80
  81         ret = setup_flash_device();
  82         if (ret)
  83                 return ret;
  84
  85         ret = env_export(&env_new);
  86         if (ret)
  87                 return -EIO;
  88         env_new.flags   = ACTIVE_FLAG;
  89
  90         if (gd->env_valid == ENV_VALID) {
  91                 env_new_offset = CONFIG_ENV_OFFSET_REDUND;
  92                 env_offset = CONFIG_ENV_OFFSET;
  93         } else {
  94                 env_new_offset = CONFIG_ENV_OFFSET;
  95                 env_offset = CONFIG_ENV_OFFSET_REDUND;
  96         }
  97
  98         /* Is the sector larger than the env (i.e. embedded) */
  99         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 100                 saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
 101                 saved_offset = env_new_offset + CONFIG_ENV_SIZE;
 102                 saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
 103                 if (!saved_buffer) {
 104                         ret = -ENOMEM;
 105                         goto done;
 106                 }
 107                 ret = spi_flash_read(env_flash, saved_offset,
 108                                         saved_size, saved_buffer);
 109                 if (ret)
 110                         goto done;
 111         }
 112
 113         sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
 114
 115         puts("Erasing SPI flash...");
 116         ret = spi_flash_erase(env_flash, env_new_offset,
 117                                 sector * CONFIG_ENV_SECT_SIZE);
 118         if (ret)
 119                 goto done;
 120
 121         puts("Writing to SPI flash...");
 122
 123         ret = spi_flash_write(env_flash, env_new_offset,
 124                 CONFIG_ENV_SIZE, &env_new);
 125         if (ret)
 126                 goto done;
 127
 128         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 129                 ret = spi_flash_write(env_flash, saved_offset,
 130                                         saved_size, saved_buffer);
 131                 if (ret)
 132                         goto done;
 133         }
 134
 135         ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
 136                                 sizeof(env_new.flags), &flag);
 137         if (ret)
 138                 goto done;
 139
 140         puts("done\n");
 141
 142         gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
 143
 144         printf("Valid environment: %d\n", (int)gd->env_valid);
 145
 146  done:
 147         if (saved_buffer)
 148                 free(saved_buffer);
 149
 150         return ret;
 151 }
 152 #endif /* CMD_SAVEENV */
 153
 154 static int env_sf_load(void)
 155 {
 156         int ret;
 157         int read1_fail, read2_fail;
 158         env_t *tmp_env1, *tmp_env2;
 159
 160         tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 161                         CONFIG_ENV_SIZE);
 162         tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 163                         CONFIG_ENV_SIZE);
 164         if (!tmp_env1 || !tmp_env2) {
 165                 env_set_default("malloc() failed", 0);
 166                 ret = -EIO;
 167                 goto out;
 168         }
 169
 170         ret = setup_flash_device();
 171         if (ret)
 172                 goto out;
 173
 174         read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
 175                                     CONFIG_ENV_SIZE, tmp_env1);
 176         read2_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
 177                                     CONFIG_ENV_SIZE, tmp_env2);
 178
 179         ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
 180                                 read2_fail);
 181
 182         spi_flash_free(env_flash);
 183         env_flash = NULL;
 184 out:
 185         free(tmp_env1);
 186         free(tmp_env2);
 187
 188         return ret;
 189 }
 190 #else
 191 #ifdef CMD_SAVEENV
 192 static int env_sf_save(void)
 193 {
 194         u32     saved_size, saved_offset, sector;
 195         char    *saved_buffer = NULL;
 196         int     ret = 1;
 197         env_t   env_new;
 198
 199         ret = setup_flash_device();
 200         if (ret)
 201                 return ret;
 202
 203         /* Is the sector larger than the env (i.e. embedded) */
 204         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 205                 saved_size = CONFIG_ENV_SECT_SIZE - CONFIG_ENV_SIZE;
 206                 saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
 207                 saved_buffer = malloc(saved_size);
 208                 if (!saved_buffer)
 209                         goto done;
 210
 211                 ret = spi_flash_read(env_flash, saved_offset,
 212                         saved_size, saved_buffer);
 213                 if (ret)
 214                         goto done;
 215         }
 216
 217         ret = env_export(&env_new);
 218         if (ret)
 219                 goto done;
 220
 221         sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, CONFIG_ENV_SECT_SIZE);
 222
 223         puts("Erasing SPI flash...");
 224         ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
 225                 sector * CONFIG_ENV_SECT_SIZE);
 226         if (ret)
 227                 goto done;
 228
 229         puts("Writing to SPI flash...");
 230         ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
 231                 CONFIG_ENV_SIZE, &env_new);
 232         if (ret)
 233                 goto done;
 234
 235         if (CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE) {
 236                 ret = spi_flash_write(env_flash, saved_offset,
 237                         saved_size, saved_buffer);
 238                 if (ret)
 239                         goto done;
 240         }
 241
 242         ret = 0;
 243         puts("done\n");
 244
 245  done:
 246         if (saved_buffer)
 247                 free(saved_buffer);
 248
 249         return ret;
 250 }
 251 #endif /* CMD_SAVEENV */
 252
 253 static int env_sf_load(void)
 254 {
 255         int ret;
 256         char *buf = NULL;
 257
 258         buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
 259         if (!buf) {
 260                 env_set_default("malloc() failed", 0);
 261                 return -EIO;
 262         }
 263
 264         ret = setup_flash_device();
 265         if (ret)
 266                 goto out;
 267
 268         ret = spi_flash_read(env_flash,
 269                 CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
 270         if (ret) {
 271                 env_set_default("spi_flash_read() failed", 0);
 272                 goto err_read;
 273         }
 274
 275         ret = env_import(buf, 1);
 276         if (!ret)
 277                 gd->env_valid = ENV_VALID;
 278
 279 err_read:
 280         spi_flash_free(env_flash);
 281         env_flash = NULL;
 282 out:
 283         free(buf);
 284
 285         return ret;
 286 }
 287 #endif
 288
 289 #ifdef CONFIG_ENV_ADDR
 290 __weak void *env_sf_get_env_addr(void)
 291 {
 292         return (void *)CONFIG_ENV_ADDR;
 293 }
 294 #endif
 295
 296 #if defined(INITENV) && defined(CONFIG_ENV_ADDR)
 297 static int env_sf_init(void)
 298 {
 299         env_t *env_ptr = (env_t *)env_sf_get_env_addr();
 300
 301         if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
 302                 gd->env_addr    = (ulong)&(env_ptr->data);
 303                 gd->env_valid   = 1;
 304         } else {
 305                 gd->env_addr = (ulong)&default_environment[0];
 306                 gd->env_valid = 1;
 307         }
 308
 309         return 0;
 310 }
 311 #endif
 312
 313 U_BOOT_ENV_LOCATION(sf) = {
 314         .location       = ENVL_SPI_FLASH,
 315         ENV_NAME("SPI Flash")
 316         .load           = env_sf_load,
 317 #ifdef CMD_SAVEENV
 318         .save           = env_save_ptr(env_sf_save),
 319 #endif
 320 #if defined(INITENV) && defined(CONFIG_ENV_ADDR)
 321         .init           = env_sf_init,
 322 #endif
 323 };