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 <env_internal.h>
  15 #include <flash.h>
  16 #include <malloc.h>
  17 #include <spi.h>
  18 #include <spi_flash.h>
  19 #include <search.h>
  20 #include <errno.h>
  21 #include <uuid.h>
  22 #include <asm/cache.h>
  23 #include <asm/global_data.h>
  24 #include <dm/device-internal.h>
  25 #include <u-boot/crc.h>
  26
  27 #ifndef CONFIG_SPL_BUILD
  28 #define INITENV
  29 #endif
  30
  31 #define OFFSET_INVALID          (~(u32)0)
  32
  33 #ifdef CONFIG_ENV_OFFSET_REDUND
  34 #define ENV_OFFSET_REDUND       CONFIG_ENV_OFFSET_REDUND
  35
  36 static ulong env_offset         = CONFIG_ENV_OFFSET;
  37 static ulong env_new_offset     = CONFIG_ENV_OFFSET_REDUND;
  38
  39 #else
  40
  41 #define ENV_OFFSET_REDUND       OFFSET_INVALID
  42
  43 #endif /* CONFIG_ENV_OFFSET_REDUND */
  44
  45 DECLARE_GLOBAL_DATA_PTR;
  46
  47 static struct spi_flash *env_flash;
  48
  49 static int setup_flash_device(void)
  50 {
  51 #if CONFIG_IS_ENABLED(DM_SPI_FLASH)
  52         struct udevice *new;
  53         int     ret;
  54
  55         /* speed and mode will be read from DT */
  56         ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
  57                                      CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
  58                                      &new);
  59         if (ret) {
  60                 env_set_default("spi_flash_probe_bus_cs() failed", 0);
  61                 return ret;
  62         }
  63
  64         env_flash = dev_get_uclass_priv(new);
  65 #else
  66         if (env_flash)
  67                 spi_flash_free(env_flash);
  68
  69         env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
  70                                     CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
  71         if (!env_flash) {
  72                 env_set_default("spi_flash_probe() failed", 0);
  73                 return -EIO;
  74         }
  75 #endif
  76         return 0;
  77 }
  78
  79 #if defined(CONFIG_ENV_OFFSET_REDUND)
  80 static int env_sf_save(void)
  81 {
  82         env_t   env_new;
  83         char    *saved_buffer = NULL, flag = ENV_REDUND_OBSOLETE;
  84         u32     saved_size = 0, saved_offset = 0, sector;
  85         u32     sect_size = CONFIG_ENV_SECT_SIZE;
  86         int     ret;
  87
  88         ret = setup_flash_device();
  89         if (ret)
  90                 return ret;
  91
  92         if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
  93                 sect_size = env_flash->mtd.erasesize;
  94
  95         ret = env_export(&env_new);
  96         if (ret)
  97                 return -EIO;
  98         env_new.flags   = ENV_REDUND_ACTIVE;
  99
 100         if (gd->env_valid == ENV_VALID) {
 101                 env_new_offset = CONFIG_ENV_OFFSET_REDUND;
 102                 env_offset = CONFIG_ENV_OFFSET;
 103         } else {
 104                 env_new_offset = CONFIG_ENV_OFFSET;
 105                 env_offset = CONFIG_ENV_OFFSET_REDUND;
 106         }
 107
 108         /* Is the sector larger than the env (i.e. embedded) */
 109         if (sect_size > CONFIG_ENV_SIZE) {
 110                 saved_size = sect_size - CONFIG_ENV_SIZE;
 111                 saved_offset = env_new_offset + CONFIG_ENV_SIZE;
 112                 saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
 113                 if (!saved_buffer) {
 114                         ret = -ENOMEM;
 115                         goto done;
 116                 }
 117                 ret = spi_flash_read(env_flash, saved_offset,
 118                                         saved_size, saved_buffer);
 119                 if (ret)
 120                         goto done;
 121         }
 122
 123         sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
 124
 125         puts("Erasing SPI flash...");
 126         ret = spi_flash_erase(env_flash, env_new_offset,
 127                                 sector * sect_size);
 128         if (ret)
 129                 goto done;
 130
 131         puts("Writing to SPI flash...");
 132
 133         ret = spi_flash_write(env_flash, env_new_offset,
 134                 CONFIG_ENV_SIZE, &env_new);
 135         if (ret)
 136                 goto done;
 137
 138         if (sect_size > CONFIG_ENV_SIZE) {
 139                 ret = spi_flash_write(env_flash, saved_offset,
 140                                         saved_size, saved_buffer);
 141                 if (ret)
 142                         goto done;
 143         }
 144
 145         ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
 146                                 sizeof(env_new.flags), &flag);
 147         if (ret)
 148                 goto done;
 149
 150         puts("done\n");
 151
 152         gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
 153
 154         printf("Valid environment: %d\n", (int)gd->env_valid);
 155
 156 done:
 157         spi_flash_free(env_flash);
 158         env_flash = NULL;
 159
 160         if (saved_buffer)
 161                 free(saved_buffer);
 162
 163         return ret;
 164 }
 165
 166 static int env_sf_load(void)
 167 {
 168         int ret;
 169         int read1_fail, read2_fail;
 170         env_t *tmp_env1, *tmp_env2;
 171
 172         tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 173                         CONFIG_ENV_SIZE);
 174         tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 175                         CONFIG_ENV_SIZE);
 176         if (!tmp_env1 || !tmp_env2) {
 177                 env_set_default("malloc() failed", 0);
 178                 ret = -EIO;
 179                 goto out;
 180         }
 181
 182         ret = setup_flash_device();
 183         if (ret)
 184                 goto out;
 185
 186         read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
 187                                     CONFIG_ENV_SIZE, tmp_env1);
 188         read2_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
 189                                     CONFIG_ENV_SIZE, tmp_env2);
 190
 191         ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
 192                                 read2_fail, H_EXTERNAL);
 193
 194         spi_flash_free(env_flash);
 195         env_flash = NULL;
 196 out:
 197         free(tmp_env1);
 198         free(tmp_env2);
 199
 200         return ret;
 201 }
 202 #else
 203 static int env_sf_save(void)
 204 {
 205         u32     saved_size = 0, saved_offset = 0, sector;
 206         u32     sect_size = CONFIG_ENV_SECT_SIZE;
 207         char    *saved_buffer = NULL;
 208         int     ret = 1;
 209         env_t   env_new;
 210
 211         ret = setup_flash_device();
 212         if (ret)
 213                 return ret;
 214
 215         if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
 216                 sect_size = env_flash->mtd.erasesize;
 217
 218         /* Is the sector larger than the env (i.e. embedded) */
 219         if (sect_size > CONFIG_ENV_SIZE) {
 220                 saved_size = sect_size - CONFIG_ENV_SIZE;
 221                 saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
 222                 saved_buffer = malloc(saved_size);
 223                 if (!saved_buffer)
 224                         goto done;
 225
 226                 ret = spi_flash_read(env_flash, saved_offset,
 227                         saved_size, saved_buffer);
 228                 if (ret)
 229                         goto done;
 230         }
 231
 232         ret = env_export(&env_new);
 233         if (ret)
 234                 goto done;
 235
 236         sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
 237
 238         puts("Erasing SPI flash...");
 239         ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
 240                 sector * sect_size);
 241         if (ret)
 242                 goto done;
 243
 244         puts("Writing to SPI flash...");
 245         ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
 246                 CONFIG_ENV_SIZE, &env_new);
 247         if (ret)
 248                 goto done;
 249
 250         if (sect_size > CONFIG_ENV_SIZE) {
 251                 ret = spi_flash_write(env_flash, saved_offset,
 252                         saved_size, saved_buffer);
 253                 if (ret)
 254                         goto done;
 255         }
 256
 257         ret = 0;
 258         puts("done\n");
 259
 260 done:
 261         spi_flash_free(env_flash);
 262         env_flash = NULL;
 263
 264         if (saved_buffer)
 265                 free(saved_buffer);
 266
 267         return ret;
 268 }
 269
 270 static int env_sf_load(void)
 271 {
 272         int ret;
 273         char *buf = NULL;
 274
 275         buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
 276         if (!buf) {
 277                 env_set_default("malloc() failed", 0);
 278                 return -EIO;
 279         }
 280
 281         ret = setup_flash_device();
 282         if (ret)
 283                 goto out;
 284
 285         ret = spi_flash_read(env_flash,
 286                 CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
 287         if (ret) {
 288                 env_set_default("spi_flash_read() failed", 0);
 289                 goto err_read;
 290         }
 291
 292         ret = env_import(buf, 1, H_EXTERNAL);
 293         if (!ret)
 294                 gd->env_valid = ENV_VALID;
 295
 296 err_read:
 297         spi_flash_free(env_flash);
 298         env_flash = NULL;
 299 out:
 300         free(buf);
 301
 302         return ret;
 303 }
 304 #endif
 305
 306 static int env_sf_erase(void)
 307 {
 308         int ret;
 309         env_t env;
 310
 311         ret = setup_flash_device();
 312         if (ret)
 313                 return ret;
 314
 315         memset(&env, 0, sizeof(env_t));
 316         ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, &env);
 317         if (ret)
 318                 goto done;
 319
 320         if (ENV_OFFSET_REDUND != OFFSET_INVALID)
 321                 ret = spi_flash_write(env_flash, ENV_OFFSET_REDUND, CONFIG_ENV_SIZE, &env);
 322
 323 done:
 324         spi_flash_free(env_flash);
 325         env_flash = NULL;
 326
 327         return ret;
 328 }
 329
 330 #if CONFIG_ENV_ADDR != 0x0
 331 __weak void *env_sf_get_env_addr(void)
 332 {
 333         return (void *)CONFIG_ENV_ADDR;
 334 }
 335 #endif
 336
 337 #if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
 338 /*
 339  * check if Environment on CONFIG_ENV_ADDR is valid.
 340  */
 341 static int env_sf_init_addr(void)
 342 {
 343         env_t *env_ptr = (env_t *)env_sf_get_env_addr();
 344
 345         if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
 346                 gd->env_addr    = (ulong)&(env_ptr->data);
 347                 gd->env_valid   = 1;
 348         } else {
 349                 gd->env_addr = (ulong)&default_environment[0];
 350                 gd->env_valid = 1;
 351         }
 352
 353         return 0;
 354 }
 355 #endif
 356
 357 #if defined(CONFIG_ENV_SPI_EARLY)
 358 /*
 359  * early load environment from SPI flash (before relocation)
 360  * and check if it is valid.
 361  */
 362 static int env_sf_init_early(void)
 363 {
 364         int ret;
 365         int read1_fail;
 366         int read2_fail;
 367         int crc1_ok;
 368         env_t *tmp_env2 = NULL;
 369         env_t *tmp_env1;
 370
 371         /*
 372          * if malloc is not ready yet, we cannot use
 373          * this part yet.
 374          */
 375         if (!gd->malloc_limit)
 376                 return -ENOENT;
 377
 378         tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 379                         CONFIG_ENV_SIZE);
 380         if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
 381                 tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 382                                              CONFIG_ENV_SIZE);
 383
 384         if (!tmp_env1 || !tmp_env2)
 385                 goto out;
 386
 387         ret = setup_flash_device();
 388         if (ret)
 389                 goto out;
 390
 391         read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
 392                                     CONFIG_ENV_SIZE, tmp_env1);
 393
 394         if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
 395                 read2_fail = spi_flash_read(env_flash,
 396                                             CONFIG_ENV_OFFSET_REDUND,
 397                                             CONFIG_ENV_SIZE, tmp_env2);
 398                 ret = env_check_redund((char *)tmp_env1, read1_fail,
 399                                        (char *)tmp_env2, read2_fail);
 400
 401                 if (ret < 0)
 402                         goto err_read;
 403
 404                 if (gd->env_valid == ENV_VALID)
 405                         gd->env_addr = (unsigned long)&tmp_env1->data;
 406                 else
 407                         gd->env_addr = (unsigned long)&tmp_env2->data;
 408         } else {
 409                 if (read1_fail)
 410                         goto err_read;
 411
 412                 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
 413                                 tmp_env1->crc;
 414                 if (!crc1_ok)
 415                         goto err_read;
 416
 417                 /* if valid -> this is our env */
 418                 gd->env_valid = ENV_VALID;
 419                 gd->env_addr = (unsigned long)&tmp_env1->data;
 420         }
 421
 422         spi_flash_free(env_flash);
 423         env_flash = NULL;
 424
 425         return 0;
 426 err_read:
 427         spi_flash_free(env_flash);
 428         env_flash = NULL;
 429         free(tmp_env1);
 430         if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
 431                 free(tmp_env2);
 432 out:
 433         /* env is not valid. always return 0 */
 434         gd->env_valid = ENV_INVALID;
 435         return 0;
 436 }
 437 #endif
 438
 439 static int env_sf_init(void)
 440 {
 441 #if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
 442         return env_sf_init_addr();
 443 #elif defined(CONFIG_ENV_SPI_EARLY)
 444         return env_sf_init_early();
 445 #endif
 446         /*
 447          * return here -ENOENT, so env_init()
 448          * can set the init bit and later if no
 449          * other Environment storage is defined
 450          * can set the default environment
 451          */
 452         return -ENOENT;
 453 }
 454
 455 U_BOOT_ENV_LOCATION(sf) = {
 456         .location       = ENVL_SPI_FLASH,
 457         ENV_NAME("SPIFlash")
 458         .load           = env_sf_load,
 459         .save           = ENV_SAVE_PTR(env_sf_save),
 460         .erase          = ENV_ERASE_PTR(env_sf_erase),
 461         .init           = env_sf_init,
 462 };